All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisInterfaces Interface CATISamAnalysisEntityInit
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISamAnalysisEntityInit
Usage: you can reimplement this interface by deriving the supplied CATEAnalysisEntityInit adapter class.
interface CATISamAnalysisEntityInit
Customize analysis entity creation.
Role:
This interface allows to
- Insert applicative initialization. This will be called by CATISamAnalysisEntity.Initialize
after the entity creation.
- Insert applicative deletion. This will be called by the entity deletion
- Customize the user interface for the set selection.
BOA information: this interface can 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.
- See also:
- CATISamAnalysisEntity
Method Index
- o
AggregateInSet()
- Informs about the parent of an entity.
- o
CheckAnalysisSet(CATISamAnalysisSet*)
- Checks if an Analysis set is allowed.
- o
GetAnalysisSetType(CATUnicodeString&)
- Informs about a compatible set.
- o
InitWhenPositioned()
- Initializes the analysis entity.
- o
Initialize()
- Initializes the analysis entity.
- o
Remove(int)
- Removes the object.
Methods
o AggregateInSet
-
Informs about the parent of an entity.
- Returns:
-
Legal values:
- TRUE The entity is aggregated by the set.
- FALSE The entity is aggregated by the Finite Element Model
Default behavior.
o CheckAnalysisSet
-
Checks if an Analysis set is allowed.
Warning : this method will be called on a StartUp and therefor some CATISamExplicit methods will not work.
- Parameters:
-
- ipiAnalysisSet
- Interface pointer on a CATISamAnalysisSet.
- Returns:
-
Legal values:
- 0 the set is not valid.
- 1 the set is valid.
o GetAnalysisSetType
-
Informs about a compatible set.
Dedicated to the interactive command: returns the type of set that needs to be created
(if the previous method doesn't find an appropriate set).
If a type set is returned a command will be launched in order to create the set.
- See also:
- CATISamAnalysisSetInit
- Parameters:
-
- oAllowedSetType
- Late type of the set.
- Returns:
-
Legal values:
- 0 the set is not valid.
- 1 the set is valid.
o InitWhenPositioned
public virtual HRESULT InitWhenPositioned( | )= 0 |
-
Initializes the analysis entity.
This Method is called after the entity is positioned under a set, an entity or a basic component, this means
CATISamAnalysisSet.AddAnalysisEntity No specific behavoir is associated to the returned HRESULT.
o Initialize
public virtual HRESULT Initialize( | )= 0 |
-
Initializes the analysis entity.
This Method is systematically called after the entity creation, this means
CATISamAnalysisModelFactory.CreateAnalysisEntity No specific behavoir is associated to the returned HRESULT.
o Remove
public virtual HRESULT Remove( | int | iForCloseContext) = 0 |
-
Removes the object.
- Parameters:
-
- iForCloseContext
- param to specify context of remove. If removes happens while closing a document,
some actions don't need to be execute for example.
1 if remove acts while closing a document ...
No specific behavoir is associated to the returned HRESULT.
Note: Prefer this method to LifeCycleObject implementation
This object is included in the file: CATISamAnalysisEntityInit.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface