CATMecModUIExtendItf CATMmrStateCommand
Usage: you can derive this class.
public class CATMmrStateCommand
Basic class for mechanical feature creation and edition commands.
Role: This class is a base class to edit or create a mechanical feature.
Do not derive it directly, but derive one of its deriving class.
About the edited/created feature(s) :
there are two cases to consider:
- There is only one feature in edition or creation
You implement the , and the default implementation of the
method will return a list with the only one feature.
- There are several features in edition or creation
You implement the
method to return the main feature, and you implement the
method to return a list.
Constructor and Destructor Index
- o
CATMmrStateCommand(CATString&,CATDlgEngBehavior,CATCommandMode,CATPathElement*,CATPathElement*)
- Constructs a CATStateCommand for feature creation and edition.
- o
~CATMmrStateCommand()
-
Method Index
- o
AddElementsInHSO(CATLISTP(CATBaseUnknown)*)
- Puts the objects of the list iObjectList in the HSO.
- o
AddInCSO(CATBaseUnknown*)
- Builds a path the leaf of which is iObject.
- o
AddInHSO(CATBaseUnknown*)
- Builds a path the leaf of which is iObject.
- o
AddInISO(CATBaseUnknown*)
- Puts iObject in the ISO.
- o
AddInPSO(CATBaseUnknown*)
- Builds a path the leaf of which is iObject.
- o
Cancel(CATCommand*,CATNotification*)
- Cancel Action.
- o
EmptySO()
- Empties the CSO, the HSO and the PSO.
- o
GetActiveObjectPath()
- Retrieves the active object path.
- o
GetCSO()
- Returns the CSO of the current editor.
- o
GetCurrentFeature()
- Gets the current feature (the in work object) of the part you are working with.
- o
GetEditor()
- Returns the current editor.
- o
GetHSO()
- Returns the HSO of the current editor.
- o
GetISO()
- Returns the ISO of the current editor.
- o
GetPSO()
- Returns the PSO of the current editor.
- o
GetPart()
- Gets the part you are working with (the part with the blue node in product context).
- o
GetWorkingPath()
- Retrieves the working path (used for highlight, etc).
- o
GiveMyFeature()
- Returns the edited or created feature.
- o
GiveMyFeatures()
- Returns the edited or created feature list.
- o
GivePathElementFrom(CATBaseUnknown*)
- Builds a path the leaf of which is iObject.
- o
SetActiveObject(CATBaseUnknown*)
- Builds a path the leaf of which is iObject.
- o
SetActiveObjectPath(CATPathElement*)
- Sets the active object path.
- o
SetCurrentFeature(CATIMmiMechanicalFeature*)
- Sets iFeature as the current feature (the in work object) of the part you are working with.
- o
SetWorkingPath(CATPathElement*)
- Sets the working path.
Data Member Index
- o
_MyFeature
- Data member you can use to store the element that is beeing created or edited.
Constructor and Destructor
- o CATMmrStateCommand
-
| public CATMmrStateCommand( | const | iName, |
| | iBehavior | = NULL, |
| | iStatus | = CATCommandModeExclusive, |
| const | iWorkingPath | = 0, |
| const | iActiveObjectPath | = 0) |
-
Constructs a CATStateCommand for feature creation and edition.
- Parameters:
-
- iName
- as in CATStateCommand
- iBehavior
- as in CATStateCommand
- iStatus
- as in CATStateCommand
- iWorkingPath
- The working path in assembly
- iActiveObjectPath
- The active object path
- See also:
-
- o ~CATMmrStateCommand
-
| public virtual ~CATMmrStateCommand( | ) |
-
Methods
- o AddElementsInHSO
-
| public AddElementsInHSO( | | iObjectList) |
-
Puts the objects of the list iObjectList in the HSO.
- o AddInCSO
-
| public AddInCSO( | | iObject) |
-
Builds a path the leaf of which is iObject.
Puts the path in the CSO.
- Parameters:
-
- iObject
- The object
- Returns:
- The path that has been generated.
The caller must release the returned path.
- o AddInHSO
-
| public AddInHSO( | | iObject) |
-
Builds a path the leaf of which is iObject.
Puts the path in the HSO.
- Parameters:
-
- iObject
- The object
- Returns:
- The path that has been generated.
The caller must release the returned path.
- o AddInISO
-
| public AddInISO( | | iObject) |
-
Puts iObject in the ISO.
- Parameters:
-
- iObject
- The object
- Returns:
- The object you pass in argument (iObject).
- o AddInPSO
-
| public AddInPSO( | | iObject) |
-
Builds a path the leaf of which is iObject.
Puts the path in the PSO.
- Parameters:
-
- iObject
- The object
- Returns:
- The path that has been generated.
The caller must release the returned path.
- o Cancel
-
| public virtual Cancel( | | iCmd, |
| | iNotif) |
-
Cancel Action.
- Parameters:
-
- iCmd
- The command that requests to cancel the current one
- iNotif
- The notification sent
- o EmptySO
-
-
Empties the CSO, the HSO and the PSO.
- o GetActiveObjectPath
-
| public GetActiveObjectPath( | ) |
-
Retrieves the active object path.
Role:
This method is used to have the good workshop.Usually the working path and the active i
path are equal: the two path contain the part and the product structure.
Use #SetActiveObjectPath to change it.
- Returns:
- The path that has been generated.
The caller must release the returned value.
- o GetCSO
-
-
Returns the CSO of the current editor.
- Returns:
- The current CSO.
Do not release the returned value.
- o GetCurrentFeature
-
| public GetCurrentFeature( | ) |
-
Gets the current feature (the in work object) of the part you are working with.
- Returns:
- The current feature.
- o GetEditor
-
-
Returns the current editor.
- Returns:
- The current editor.
Do not release the returned value.
- o GetHSO
-
-
Returns the HSO of the current editor.
- Returns:
- The current HSO.
Do not release the returned value.
- o GetISO
-
-
Returns the ISO of the current editor.
- Returns:
- The current ISO.
Do not release the returned value.
- o GetPSO
-
-
Returns the PSO of the current editor.
- Returns:
- The current PSO.
Do not release the returned value.
- o GetPart
-
-
Gets the part you are working with (the part with the blue node in product context).
- Returns:
- The part.
- o GetWorkingPath
-
-
Retrieves the working path (used for highlight, etc).
Usually the working path and the active path are equal: the two path contain
the part and the product structure.
Use
to change it.
- Returns:
- The path that has been generated.
The caller must release the returned value.
- o GiveMyFeature
-
| public virtual GiveMyFeature( | ) |
-
Returns the edited or created feature.
- Returns:
- The edited or created feature.
- o GiveMyFeatures
-
| public virtual GiveMyFeatures( | ) |
-
Returns the edited or created feature list.
- Returns:
- The edited or created feature list.
- o GivePathElementFrom
-
| public GivePathElementFrom( | | iObject) |
-
Builds a path the leaf of which is iObject.
- Parameters:
-
- iObject
- The object
- Returns:
- The path that has been generated.
The caller must release the returned value.
- o SetActiveObject
-
| public SetActiveObject( | | iObject) |
-
Builds a path the leaf of which is iObject.
Sets this path as the active object path of the editor.
- Parameters:
-
- iObject
- The leaf of the new active object path
- o SetActiveObjectPath
-
| public SetActiveObjectPath( | const | iActiveObjectPath) |
-
Sets the active object path.
- Parameters:
-
- iActiveObjectPath
- The active object path
- o SetCurrentFeature
-
| public SetCurrentFeature( | | iFeature) |
-
Sets iFeature as the current feature (the in work object) of the part you are working with.
- Parameters:
-
- iFeature
- The new current feature.
- o SetWorkingPath
-
| public SetWorkingPath( | const | iWorkingPath) |
-
Sets the working path.
- Parameters:
-
- iWorkingPath
- The working path
Data Members
- o _MyFeature
protected CATBaseUnknown_var _MyFeature
-
Data member you can use to store the element that is beeing created or edited.
Use it to implement the GiveMyFeature method.
This object is included in the file: CATMmrStateCommand.h
If needed, your Imakefile.mk should include the module: CATMecModUIExtendItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.