All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisResources Class CATEAnalysisEntityInit
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATAnalysisInterfaces.CATISamAnalysisEntityInit
|
+---CATEAnalysisEntityInit
Usage: you can derive this class.
public class CATEAnalysisEntityInit
Adapter for the implementation of CATISamAnalysisEntityInit interface.
It can be used for AnalysisEntity.
- See also:
- CATISamAnalysisEntityInit
Constructor and Destructor Index
- o
CATEAnalysisEntityInit()
- Default constructor.
- o
~CATEAnalysisEntityInit()
- Destructor.
Method Index
- o
AggregateInSet()
- Informs about the parent of an entity.
- o
CheckAnalysisSet(CATISamAnalysisSet*)
- Checks if an Analysis set if allowed.
- o
GetAnalysisSetType(CATUnicodeString&)
- Returns analysis set allowed as parent.
- o
InitWhenPositioned()
- Initializes the analysis entity.
- o
Initialize()
- Initializes the analysis entity.
- o
Remove(int)
- Removes the object.
Constructor and Destructor
o CATEAnalysisEntityInit
public CATEAnalysisEntityInit( | ) |
-
Default constructor.
o ~CATEAnalysisEntityInit
public virtual ~CATEAnalysisEntityInit( | ) |
-
Destructor.
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 if 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
-
Returns analysis set allowed as parent.
Warning : this method will be called on a StartUp and therefor some CATISamExplicit methods will not work.
- Parameters:
-
- oAllowedSetType
- analysis set type .
- Returns:
-
Legal values:
- 0 no set found.
- 1 1 set found.
- 2 too many set found.
o InitWhenPositioned
public virtual HRESULT InitWhenPositioned( | ) |
-
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
o Initialize
public virtual HRESULT Initialize( | ) |
-
Initializes the analysis entity.
This Method is systematically called after the entity creation, this means
CATISamAnalysisModelFactory.CreateAnalysisEntity
o Remove
public virtual HRESULT Remove( | int | iForCloseContext) |
-
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 ...
This object is included in the file: CATEAnalysisEntityInit.h
If needed, your Imakefile.mk should include the module: CATAnalysisResources