All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrInterfaces Interface CATIWorkbenchTransition

Usage: you can reimplement this interface by deriving the supplied CATExtIWorkbenchTransition adapter class.

interface CATIWorkbenchTransition

Interface to create transition between workbenches.
Role: Changing the current workbench to another is one of the methods proposed to the end user to go on with his/her job with another set of tools. To avoid discontinuity in the process and ensure smooth transitions between workbenches, these transitions should have been designed and implemented.

The goal of this interface is to answer to this question: the document 1 is activated with the workbenchA, the workbench B is selected in the Start menu, what happens ? The workbench B is activated but with which document ?

The same document ?
An another document of the same type as the document 1?
A new document from another type ?
What happens if document 1 contains a document which can match the workbench B ?

You should implement the CATIWorkbenchTransition interface, for each workshop, using an extension of a late type made of the workshop identifier suffixed by _trans, such as MyWorkshop_trans for the MyWorkshop'workshop.To do this you should make a class that derives from . The aim of this implementation is only to activate the right workshop if needed. Then the activation of the requested workbench is done automatically.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

Method Index

o DoTransition(CATString&,CATString&,CATString&,CATString&): Handles or not the transition if possible.

Methods

o DoTransition

public virtual DoTransition(	const	`iFromWorkshop`,
	const	`iFromWorkbench`,
	const	`iToWorkshop`,
	const	`iToWorkbench`)

Handles or not the transition if possible.
Role: Transitions ( from and) to your workbench should be designed knowing that CATIA calls the workshops involved in the transition on their DoTransition methods in the following order:

The active workshop, iFromWorkshop
The selected workshop, or the workshop to which the selected workbench belongs, iToWorkshop

Any of them can decide what to do when a transition occurs. CATIA calls them in that order until one of them decides.If the active workshop decides, the selected is not called. However the selected workshop generally decides, since incoming transitions only should be implemented. If none decides, this means that the transition involves two workbenches of the same workshop, and simply switches these workbenches.

Parameters:

iFromWorkshop: The active workshop
iFromWorkbench: The active workbench
iToWorkshop: The selected workshop, or the workshop to which the selected workbench belongs.
iToWorkbench: The selected workbench

Returns:

1 if handled, 0 otherwise

This object is included in the file: CATIWorkbenchTransition.h
If needed, your Imakefile.mk should include the module: CATAfrItf