All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Interface CATISamAnalysisEntity
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamAnalysisEntity
Interface to define the Analysis entity.
Role:
This interface allows to
- Initialize an entity
- Retrieve the Basic components defined as parameters
- Retrieve the Analysis Model to which the entity is generated.
Complete the feature catalog definition.
Retrieve some feature catalog definition.
Method Index
- o
AddAnalysisEntity(CATISpecObject_var&)
- Adds the given entity to the list of local analysis Entities.
- o
AddBasicComponent(CATUnicodeString&,CATUnicodeString&,CATBaseUnknown_var&)
- Adds an optional Basic component to an AnalysisEntity.
- o
AddNeutralFeature(CATISpecObject_var&)
- Appends a feature to this Analysis entity.
- o
AddOutputFeature(CATISpecObject_var&,CATBoolean)
- Appends a feature to this Analysis Entity.
- o
GetBasicComponents(CATLISTV(CATBaseUnknown_var)*&,CATUnicodeString&)
- Retrieves the list of basic components corresponding to a given type.
- o
GetCollectMode(SAM_CollectParameter&)
- Retrieves the Collect mode defined on the AnalysisEntity.
- o
GetFEMModel(CATISamAnalysisModel*&)
- Retrieves the FEM Model in which the entity is defined.
- o
GetFatherEntity(CATISpecObject_var&)
- Retrieves the master entity.
- o
GetFatherSets(CATLISTV(CATBaseUnknown_var)*&)
- Retrieves the list of analysis sets that reference the analysis entity.
- o
GetLocalEntities(CATLISTV(CATBaseUnknown_var)*&)
- Retrieves the list of local entities.
- o
GetNamedBasicComponent(CATUnicodeString&,CATISamBasicComponent_var&)
- Retrieves the basic component corresponding to a given name.
- o
GetSettingsMode()
- Retrieves the settings mode behavoir.
- o
Initialize()
- Initializes the analysis entity.
- o
IsLocal()
- Retrieves if the Entity is Local or Global.
- o
IsReadOnly()
- Returns the rights on this analysis entity.
- o
ListNeutralFeatures(CATLISTV(CATISpecObject_var)&,IID&)
- Retrieves all the Neutral Feature's responding to a given interface.
- o
ListOutputFeature(CATLISTV(CATISpecObject_var)&,IID&)
- Retrieves all the Output Feature's responding to a given interface.
- o
NeedMeshingControl()
- Retrieves if the support selection needs to control that a meshpart is defined on the
body of the support.
- o
RemoveAllNeutralFeatures(IID&)
- Removes all the Neutral Feature's responding to a given interface.
- o
RemoveAnalysisEntity(CATISpecObject_var&)
- Removes a given entity from the list of local analysis Entities.
- o
RemoveBasicComponent(CATUnicodeString&)
- Removes an optional Basic componentto an AnalysisEntity.
- o
RemoveNeutralFeature(CATISpecObject_var&)
- Removes a feature to this Analysis Set.
- o
RemoveOutputFeature(CATISpecObject_var&)
- Removes a feature to this Analysis Entity.
- o
SetCollectMode(SAM_CollectParameter&)
- Sets the Collect mode defined on the AnalysisEntity.
- o
SetLocal()
- Sets the Local mode defined on the AnalysisEntity.
- o
SetMeshingControl(CATBoolean)
- Sets if the support selection needs to control that a meshpart is defined on the
body of the support.
- o
SetReadOnly(CATBoolean)
- Sets the rights on this analysis entity.
- o
SetSettingsMode(CATBoolean)
- Sets the settings mode behavoir.
Methods
o AddAnalysisEntity
| public virtual AddAnalysisEntity( | const | iEntity) |
-
Adds the given entity to the list of local analysis Entities.
- Parameters:
-
- iEntity:
- The local entity to refrerence.
o AddBasicComponent
| public virtual AddBasicComponent( | const | iBCName, |
| const | iLiteralName | =NULL, |
| const | iType | = NULL_var ) |
-
Adds an optional Basic component to an AnalysisEntity.
Returns the identifiers of the optional basic components
- Parameters:
-
- iBCName
- : List of Basic Components name, this is name of instance.
- iLiteralName:
- List of Basic Components name, this is name of startup.
- iType
- : Used only in the case of Literal features. CATICkeType of the literal to derive.
For Example, use static CATICkeType_var MyLength = CATIParmDictionary::LengthType to create a length dimension.
- See also:
- CATIParmDictionary
- iType
o AddNeutralFeature
| public virtual AddNeutralFeature( | const | iFeature) |
-
Appends a feature to this Analysis entity.
This feature will be aggregated as an neutral of the entity.
Note:
- This feature must be in the same document of the current one.
- Quality of the feature link is Neutral.
- No view of this link can be created in the field model.
- This feature will be shown in the feature tree and for 3D vizualisation.
- Parameters:
-
- iFeature
- The feature to be added.
o AddOutputFeature
| public virtual AddOutputFeature( | const | iFeature, |
| | iWithFieldModel | =FALSE) |
-
Appends a feature to this Analysis Entity. This feature will be aggregated as
an output of the Entity.
- Parameters:
-
- iFeature
- The feature to be added.
- iWithFieldModel
- Defines if a Field model Structure needs to be managed. Legal values:
TRUE The Field model object associated to iFeature is created. For this the
iFeature needs to have a Physical type.
FALSE No Field model structure will be created.
o GetBasicComponents
| public virtual GetBasicComponents( | | oComponents, |
| const | iType | =NULL) |
-
Retrieves the list of basic components corresponding to a given type.
If no type is given, every component is returned.
Warning : you have to deal with the list destruction.
- Parameters:
-
- oComponents
- pointer used to returned the list.
- iType
- The type of the basic component.
o GetCollectMode
| public virtual GetCollectMode( | | oCollectMode) |
-
Retrieves the Collect mode defined on the AnalysisEntity.
- Parameters:
-
- oCollectMode
- The collect mode.
o GetFEMModel
| public virtual GetFEMModel( | | oFEMModel) |
-
Retrieves the FEM Model in which the entity is defined.
- Parameters:
-
- oFEMModel
- [out , CATBaseUnknown#Release] The Finite Element Model in which the entity is defined.
It implements CATISamAnalysisModel
o GetFatherEntity
| public virtual GetFatherEntity( | | oEntity) |
-
Retrieves the master entity.
Only for Local AnalysisEntity
- Parameters:
-
- oEntity:
- The mater entity.
o GetFatherSets
| public virtual GetFatherSets( | | oListOfSets) |
-
Retrieves the list of analysis sets that reference the analysis entity.
- Parameters:
-
- oListOfSets
- Collection of analysis sets.
o GetLocalEntities
| public virtual GetLocalEntities( | | oLocalEntities) |
-
Retrieves the list of local entities.
- Parameters:
-
- oLocalEntities:
- The Local entities.
o GetNamedBasicComponent
| public virtual GetNamedBasicComponent( | const | iName, |
| | oComponent) |
-
Retrieves the basic component corresponding to a given name.
- Parameters:
-
- iName
- name of the basic components.
- oComponents
- pointer used to returned the list.
o GetSettingsMode
| public virtual GetSettingsMode( | ) |
-
Retrieves the settings mode behavoir.
Legal values:
TRUE The analysis entity manages automatic settings for basic component values.
FALSE The analysis entity don't manage automatic settings for basic component values.
o Initialize
| public virtual Initialize( | ) |
-
Initializes the analysis entity.
This Method is called after the entity is created and positioned. Do not use.
o IsLocal
-
Retrieves if the Entity is Local or Global.
- Returns:
- TRUE if the entity is local.
o IsReadOnly
| public virtual IsReadOnly( | ) |
-
Returns the rights on this analysis entity.
Legal values:
TRUE The analysis entity is "locked".
FALSE The Analysis entity can be modified.
o ListNeutralFeatures
| public virtual ListNeutralFeatures( | | oEntitiesList, |
| const | iIntfIID) |
-
Retrieves all the Neutral Feature's responding to a given interface.
- Parameters:
-
- oFeatureList
- The collection of Feature's found.
- iIntfIID
- Identifier of the interface filtering the kind of objects to find.
o ListOutputFeature
| public virtual ListOutputFeature( | | oEntitiesList, |
| const | iIntfIID) |
-
Retrieves all the Output Feature's responding to a given interface.
- Parameters:
-
- oFeatureList
- The collection of Feature's found.
- iIntfIID
- Identifier of the interface filtering the kind of objects to find.
o NeedMeshingControl
| public virtual NeedMeshingControl( | ) |
-
Retrieves if the support selection needs to control that a meshpart is defined on the
body of the support.
This control is done for Rsur, Redge, Mechanical feature support type.
- Returns:
- TRUE if the control is required.
o RemoveAllNeutralFeatures
| public virtual RemoveAllNeutralFeatures( | const | iIntfIID) |
-
Removes all the Neutral Feature's responding to a given interface.
- Parameters:
-
- oFeatureList
- The collection of Feature's found.
- iIntfIID
- Identifier of the interface filtering the kind of objects to find.
o RemoveAnalysisEntity
| public virtual RemoveAnalysisEntity( | const | iEntity) |
-
Removes a given entity from the list of local analysis Entities.
- Parameters:
-
- iEntity:
- The local entity to remove.
o RemoveBasicComponent
| public virtual RemoveBasicComponent( | const | iBcName) |
-
Removes an optional Basic componentto an AnalysisEntity.
- Parameters:
-
- iBCName
- the name of the Basic Component to remove.
o RemoveNeutralFeature
| public virtual RemoveNeutralFeature( | const | iFeature) |
-
Removes a feature to this Analysis Set.
This feature will be aggregated as an neutral of the entity.
- Parameters:
-
- iFeature
- The feature to be removed.
o RemoveOutputFeature
| public virtual RemoveOutputFeature( | const | iFeature) |
-
Removes a feature to this Analysis Entity. This feature was previously added with the
AddOutputFeature method.
- Parameters:
-
- iFeature
- The feature to be removed.
o SetCollectMode
| public virtual SetCollectMode( | | iCollectMode) |
-
Sets the Collect mode defined on the AnalysisEntity.
- Parameters:
-
- iCollectMode
- The collect mode.
o SetLocal
| public virtual SetLocal( | ) |
-
Sets the Local mode defined on the AnalysisEntity.
o SetMeshingControl
| public virtual SetMeshingControl( | | iNeed) |
-
Sets if the support selection needs to control that a meshpart is defined on the
body of the support.
This control is done for Rsur, Redge, Mechanical feature support type.
- Parameters:
-
- TRUE
- if the control is required.
o SetReadOnly
| public virtual SetReadOnly( | const | iRights) |
-
Sets the rights on this analysis entity.
- Parameters:
-
- iRights:
- Legal values:
TRUE The analysis entity is locked..
FALSE The analysis entity can be modified.
o SetSettingsMode
| public virtual SetSettingsMode( | | iMode) |
-
Sets the settings mode behavoir.
- Parameters:
-
- iMode:
- Legal values:
TRUE The analysis entity manages automatic settings for basic component values.
FALSE The analysis entity don't manage automatic settings for basic component values.
This object is included in the file: CATISamAnalysisEntity.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface