All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisInterfaces Interface CATICharacCollector
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICharacCollector
Usage: you can reimplement this interface by deriving the supplied CATECharacCollector adapter class.
interface CATICharacCollector
Capability for a feature to return collector's.
Interface designed to ensure the possibility for analysis
features to give access to collector characteristics.
This interface must be implemented on feature build by derivation of AnalysisSet or AnalysisEntity
with a physical type defined.
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:
- CATAnalysisCharacCollector, CATSamCharacVersion
Method Index
- o
DeleteAll()
- Delete all instances of CATAnalysisCharacCollector created under the current Feature.
- o
DeleteCharacCollector(CATAnalysisCharacCollector*&)
- Delete the instance of CATAnalysisCharacCollector pointed by the parameter iCharacCollector.
- o
GetAvailableEntityPhysicalTypes(CATSamPhysicalType,int&,CATSamPhysicalType*&)
- Retrieves the list of available Entities physical types for a Charac PhysicalTypes.
- o
GetAvailablePhysicalTypes(int&,CATSamPhysicalType*&,CATString*&)
- Retrieves the list of available collector characteristic physical types for the current set.
- o
GetAvailablePositions(CATSamPhysicalType,CATSamCharacVersion&,int&,CATString*&)
- Retrieves the list of position identifiers for the current set, physical type and version identifier.
- o
GetAvailableVersions(CATSamPhysicalType,int&,CATSamCharacVersion*&)
- Retrieves the list of versions for the current set, and a physical type.
- o
GetCharacCollector(CATSamPhysicalType,CATSamCharacVersion&,CATString&,char* const,CATAnalysisCharacCollector*&,CATBoolean,CATSamPhysicalType)
- Retrieves a pointer on a CATAnalysisCharacCollector on the implementing feature
according to the physical type, position identifier, version and list of entities.
- o
GetCharacCollectorsForOccurrences(int&,CATAnalysisCharacCollector* const*&,CATBoolean)
- Retrieves an array of pointer on the CATAnalysisCharacCollector of the occurrences for the current set.
- o
GetContext(CATAnalysisExplicitParent&)
- Return the Context.
- o
GetContextModel(CATAnalysisExplicitModel*&)
- Get context Model for collect.
- o
GetCurrentOccurrence(int&)
- Retrieves the current occurrence number for the current set.
- o
GetNumberOfOccurrences(int&)
- Retrieves the list of occurrences for the current set.
- o
IsAnAvailableDefinition(CATSamPhysicalType,CATSamCharacVersion&,CATString&,CATBoolean&)
- Check if a complete definiton (physical type, position identifier, version) of a
CATAnalysisCharacCollector on the implementing feature is available.
- o
SetContextModel(CATAnalysisExplicitModel*)
- Set context Model for collect.
- o
SetCurrentOccurrence(int)
- Set the current occurrence number for the current set.
- o
Update(CATBoolean)
- Update internal data.
Methods
o DeleteAll
public virtual HRESULT DeleteAll( | )= 0 |
-
Delete all instances of CATAnalysisCharacCollector created under the current Feature.
o DeleteCharacCollector
-
Delete the instance of CATAnalysisCharacCollector pointed by the parameter iCharacCollector.
- Parameters:
-
- iCharacCollector
- The pointer on the instance of CATAnalysisCharacCollector to delete.
o GetAvailableEntityPhysicalTypes
-
Retrieves the list of available Entities physical types for a Charac PhysicalTypes.
- Parameters:
-
- iCharacPhysicalType
- The charac physical type
- oNumber
- The number of different physical types (can be 0).
- oPhysicalTypes[Number]
- A pointer to the table of physical types.
o GetAvailablePhysicalTypes
-
Retrieves the list of available collector characteristic physical types for the current set.
The unit category for each physical type is also returned.
- Parameters:
-
- oNumber
- The number of different physical types (can be 0).
- oPhysicalTypes[Number]
- A pointer to the table of physical types.
- oUnits[Number]
- A pointer to the table of unit category identifiers.
o GetAvailablePositions
-
Retrieves the list of position identifiers for the current set, physical type and version identifier.
- Parameters:
-
- iPhysicalType
- The physical type
- iVersion
- The version identifier.
- oNumber
- The number of different positions.
- oPositions[Number]
- A pointer to the table of position identifiers.
The pre-defined positions are : NONE, NODE, DOF, ELEMENT, EDGE, FACE, CENTER, NODE_OF_ELEMENT and GAUSS.
o GetAvailableVersions
-
Retrieves the list of versions for the current set, and a physical type.
Only non combined versions are retrieved.
- Parameters:
-
- iPhysicalType
- The physical type
- oNumber
- The number of different versions.
- oVersions[Number]
- A pointer to the table of versions (CATSamCharacVersion objects).
- See also:
- CATSamCharacVersion
o GetCharacCollector
-
Retrieves a pointer on a CATAnalysisCharacCollector on the implementing feature
according to the physical type, position identifier, version and list of entities.
To obtain a CharacCollector with combined values:
- Use the method GetCharacCollector with a Version with ValuesAreCombined set to TRUE.
- If the method returns a null CharacCollector, use again the method with the same Version
and attribute ValuesAreCombined set to FALSE.
- Call the class method CATAnalysisCharacCollector::CombineValues().
- Parameters:
-
- iPhysicalType
- The physical type
- iVersion
- The version (CATSamCharacVersion object).
- iPosition
- The position identifier.
The pre-defined positions are : NONE, NODE, DOF, ELEMENT, EDGE, FACE, CENTER, NODE_OF_ELEMENT and GAUSS.
- iEntityFlags[NbEntities]
- A pointer to the table of entity flags indicating which entities should
have their values collected.
If a CATAnalysisCharacCollector of the correct version already exists
it will be updated if it does not contain values for all of the entities.
If this pointer is NULL, then it is assumed that values for all entities are
requested.
- oCharacCollector
- A pointer to a CATAnalysisCharacCollector object.
- See also:
- CATSamCharacVersion, CATAnalysisCharacCollector
o GetCharacCollectorsForOccurrences
public virtual HRESULT GetCharacCollectorsForOccurrences( | int& | oNbCharacCollectors, |
| const CATAnalysisCharacCollector* const*& | oCharacCollectors, |
| const CATBoolean | iCollectValues | = TRUE) = 0 |
-
Retrieves an array of pointer on the CATAnalysisCharacCollector of the occurrences for the current set.
- Parameters:
-
- oNbCharacCollectors
- The number of CATAnalysisCharacCollector objects.
- oCharacCollectors
- An array of pointer to CATAnalysisCharacCollector objects.
o GetContext
-
Return the Context.
- Parameters:
-
- oContext
- The Context is the explicit set or entity that represent the feature that implement the interface.
o GetContextModel
-
Get context Model for collect.
Return the context for wich the Characcollector is computed.
This context may influence the sequential numbering of field model entities or the value itself,
(for example apply th positionning matrix of the analysis instance in an assembly)
- Parameters:
-
- oModelContext
- The pointer on the instance of CATAnalysisExplicitModel.
o GetCurrentOccurrence
public virtual HRESULT GetCurrentOccurrence( | int& | oOccurrenceNumber) = 0 |
-
Retrieves the current occurrence number for the current set.
- Parameters:
-
- oOccurrenceNumber
- For Single Occurrence returns -1.
For Multi Occurrence returns [0,n-1] or -1 if the Charac not linked to any particular Occurrence or to all of them.
o GetNumberOfOccurrences
public virtual HRESULT GetNumberOfOccurrences( | int& | oNumberOfOccurrences) = 0 |
-
Retrieves the list of occurrences for the current set.
- Parameters:
-
- oNumberOfOccurrences
- 0 means Single Occurrence.
N (N>0) means Multi Occurrence.
o IsAnAvailableDefinition
-
Check if a complete definiton (physical type, position identifier, version) of a
CATAnalysisCharacCollector on the implementing feature is available.
- Parameters:
-
- iPhysicalType
- The physical type
- iVersion
- The version (CATSamCharacVersion object).
- iPosition
- The position identifier.
The pre-defined positions are : NONE, NODE, DOF, ELEMENT, EDGE, FACE, CENTER, NODE_OF_ELEMENT and GAUSS.
- oIsCollectable
- The definition is availability status for the complete definition.
- See also:
- CATSamCharacVersion, CATAnalysisCharacCollector
o SetContextModel
-
Set context Model for collect.
Defines the context for wich the Characcollector is computed.
This context may influence the sequential numbering of field model entities or the value itself,
(for example apply th positionning matrix of the analysis instance in an assembly)
- Parameters:
-
- iModelContext
- The pointer on the instance of CATAnalysisExplicitModel.
o SetCurrentOccurrence
public virtual HRESULT SetCurrentOccurrence( | const int | iOccurrenceNumber) = 0 |
-
Set the current occurrence number for the current set.
- Parameters:
-
- iOccurrenceNumber
o Update
-
Update internal data.
This object is included in the file: CATICharacCollector.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface