All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Interface CATISamBasicComponentManager
Usage: you can reimplement this interface by deriving the supplied CATSamBasicComponentManagerAdaptor adapter class.
interface CATISamBasicComponentManager
Defines optionnal Basic Components on Analysis Entity or AnalysisSet.
Role: The basic components that defines the physics on a preprocessing feature
are defined by default inside the startup definition. In this case, they are considered as
mandatory. This Interface allow to add, when required, some others basic component.
It can be implemented on features build by derivation of AnalysisEntity or AnalysisSet.
Note: The methods acting on the status of the frames can be used on the basic
components defined on the startup and the optionnal ones.
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.
- See also:
- CATISamAnalysisEntity, CATISamAnalysisEntity, CATISamBasicComponent
Method Index
- o
GetNbOptionalBC(int&)
- Returns the number of optional Basic Components.
- o
GetOptionalBCList(CATListValCATUnicodeString&,CATListValCATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
- Returns the identifiers of the optional basic components.
- o
IsBasicComponentHidden(CATISamBasicComponent*)
- Returns if the Basic Component frame is hidden.
- o
IsBasicComponentReadOnly(CATISamBasicComponent*)
- Returns if the Basic Component frame is ReadOnly.
- o
IsBasicComponentRecordable(CATISamBasicComponent*)
- Returns if the Basic Component participates to the Macros recording.
Methods
o GetNbOptionalBC
| public virtual GetNbOptionalBC( | | oNbOptionalBC) |
-
Returns the number of optional Basic Components.
- Parameters:
-
- NbOptionalBC
- : the number of optional Basic Components.
o GetOptionalBCList
| public virtual GetOptionalBCList( | | oBCNameList, |
| | oBCTypeList, |
| | oListOfCATICkeType) |
-
Returns the identifiers of the optional basic components.
- Parameters:
-
- oBCNameList
- : List of Basic Components name, this is name of instance.
- oBCTypeList
- : List of Basic Components name, this is name of startup.
- oListOfCATICkeType
- : 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
o IsBasicComponentHidden
| public virtual IsBasicComponentHidden( | const | iBasicComponent) |
-
Returns if the Basic Component frame is hidden.
- Parameters:
-
- iBasicComponent
- : the basic component
- Returns:
- SAMHiddenState
- See also:
- SAMHiddenState
o IsBasicComponentReadOnly
| public virtual IsBasicComponentReadOnly( | const | iBasicCompoment) |
-
Returns if the Basic Component frame is ReadOnly.
- Parameters:
-
- iBasicComponent
- : the basic component
- Returns:
- SAMReadOnlyState
- See also:
- SAMReadOnlyState
o IsBasicComponentRecordable
| public virtual IsBasicComponentRecordable( | const | iBasicCompoment) |
-
Returns if the Basic Component participates to the Macros recording.
The hypothesis is that your entity or set is managed by CATSamCreateEntityCmd.
- Parameters:
-
- iBasicComponent
- : the basic component
- Returns:
-
- TRUE if the basic component is recorded. This is the default.
- FALSE if the basic component is hidden.
This object is included in the file: CATISamBasicComponentManager.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface