All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisResources Class CATECharacCollector

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATECharacCollector
 

Usage: you can derive this class.


public class CATECharacCollector

Adapter for the implementation of CATICharacCollector interface.
It can be used for both for AnalysisSet and AnalysisEntity.

See also:
CATICharacCollector, CATAnalysisCharacCollector, CATSamCharacVersion


Constructor and Destructor Index


o CATECharacCollector()
Default constructor.
o ~CATECharacCollector()
Destructor.

Method Index


o AssignArchiverToCollector(CATAnalysisCharacCollector*,CollectorArchiveFlag)
Creates the link from the XharacCollector to its archiver.
o CollectorIsForAllEntities(CATAnalysisCharacCollector*,CATBoolean&)
Returns if CharacCollector has been built for all entities.
o DeleteAll()
Delete all instances of CATAnalysisCharacCollector.
o DeleteCharacCollector(CATAnalysisCharacCollector*&)
Deletes an instance of CATAnalysisCharacCollector.
o GetActivity()
Check the Activity of the Feature.
o GetAvailableEntityPhysicalTypes(CATSamPhysicalType,int&,CATSamPhysicalType*&)
Retrieves the list of available Entities physical types for a Charac PhysicalTypes.
o GetAvailablePhysicalTypes(int&,CATSamPhysicalType*&,CATString*&)
Returns the list of available collector characteristic physical types for the current set.
o GetAvailablePositions(CATSamPhysicalType,CATSamCharacVersion&,int&,CATString*&)
Returns the list of position identifiers for the current set, physical type and version identifier.
o GetAvailableVersions(CATSamPhysicalType,int&,CATSamCharacVersion*&)
Returns the list of versions for the current set, and a physical type.
o GetCharacCollector(CATSamPhysicalType,CATSamCharacVersion&,CATString&,char* const,CATAnalysisCharacCollector*&,boolean,CATSamPhysicalType)
Returns a CATAnalysisCharacCollector.
o GetCharacCollectorsForOccurrences(int&,CATAnalysisCharacCollector* const*&,boolean)
Returns an array of CATAnalysisCharacCollector describing the occurrences values.
o GetCollectorArchiver(CATSamPhysicalType,CATSamCharacVersion&,CATString&,CATAnalysisCollectorArchiver*&)
Returns the associated collector archiver.
o GetContext(CATAnalysisExplicitParent&)
Return the Context.
o GetContextModel(CATAnalysisExplicitModel*&)
Gets context Model for collect.
o GetCurrentOccurrence(int&)
Returns the current occurrence number for the current set.
o GetNumberOfOccurrences(int&)
Returns the list of occurrences for the current set.
o IsAnAvailableDefinition(CATSamPhysicalType,CATSamCharacVersion&,CATString&,CATBoolean&)
Asks to the implementing feature if a definition of a CATAnalysisCharacCollector is available.
o IsAuthorizedToArchiveCollectors(CATBoolean&)
Get Collector archiving autorization.
o SetCollectorArchiver(CATSamPhysicalType,CATSamCharacVersion&,CATString&,CATAnalysisCollectorArchiver*)
Assigns the associated collector archiver.
o SetContextModel(CATAnalysisExplicitModel*)
Sets context Model for collect.
o SetCurrentOccurrence(int)
Sets the current occurrence number for the current set.
o Update(CATBoolean)
Update internal data.

Constructor and Destructor


o CATECharacCollector
public CATECharacCollector()
Default constructor.
o ~CATECharacCollector
public virtual ~CATECharacCollector()
Destructor.

Methods


o AssignArchiverToCollector
protected HRESULT AssignArchiverToCollector( const CATAnalysisCharacCollector* iCharacCollector,
CollectorArchiveFlag iCollectorHadBeenAcquired)
Creates the link from the XharacCollector to its archiver.
Parameters:
iCharacCollector
The CATAnalysisCharacCollector.
iCollectorHadBeenAcquired
The status of the archiver.
o CollectorIsForAllEntities
protected HRESULT CollectorIsForAllEntities( const CATAnalysisCharacCollector* iCharacCollector,
CATBoolean& oIsForAllEntities)
Returns if CharacCollector has been built for all entities.
Parameters:
iCharacCollector
The CATAnalysisCharacCollector.
oIsForAllEntities
TRUE if the object is built for all entities.
o DeleteAll
public virtual HRESULT DeleteAll()
Delete all instances of CATAnalysisCharacCollector.
o DeleteCharacCollector
public virtual HRESULT DeleteCharacCollector( const CATAnalysisCharacCollector*& iCharacCollector)
Deletes an instance of CATAnalysisCharacCollector.
Parameters:
iCharacCollector
The pointer on the instance of CATAnalysisCharacCollector to delete.
o GetActivity
protected virtual CATBoolean GetActivity()
Check the Activity of the Feature.
o GetAvailableEntityPhysicalTypes
public virtual HRESULT GetAvailableEntityPhysicalTypes(CATSamPhysicalType iCharacPhysicalType,
int& oNumber,
const CATSamPhysicalType*& oPhysicalTypes)
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
public virtual HRESULT GetAvailablePhysicalTypes(int& oNumber,
const CATSamPhysicalType*& oPhysicalTypes,
const CATString*& oUnits) = 0
Returns the list of available collector characteristic physical types for the current set.
The unit category for each physical type is also returned.
This method must be redefined.
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
public virtual HRESULT GetAvailablePositions( const CATSamPhysicalType iPhysicalType,
const CATSamCharacVersion& iVersion,
int& oNumber,
const CATString*& oPositions) = 0
Returns the list of position identifiers for the current set, physical type and version identifier.
This method must be redefined.
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
public virtual HRESULT GetAvailableVersions( const CATSamPhysicalType iPhysicalType,
int& oNumber,
const CATSamCharacVersion*& oVersions) = 0
Returns the list of versions for the current set, and a physical type.
This method must be redefined.
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
public virtual HRESULT GetCharacCollector( const CATSamPhysicalType iPhysicalType,
const CATSamCharacVersion& iVersion,
const CATString& iPosition,
const char* const iEntityFlags,
const CATAnalysisCharacCollector*& oCharacCollector,
const boolean iCollectValues= TRUE,
const CATSamPhysicalType iEntiyPhysicalTypeToCollect= CATSamPhysicalTypeNone) = 0
Returns a CATAnalysisCharacCollector. This method must be redefined.
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.
iEntiyPhysicalTypeToCollect
Allow to filter by physical the list of entities that are scanned for building the CATAnalysisCharacCollector. This parameter is not taken into account for our implementations.
o GetCharacCollectorsForOccurrences
public virtual HRESULT GetCharacCollectorsForOccurrences(int& oNbCharacCollectors,
const CATAnalysisCharacCollector* const*& oCharacCollectors,
const boolean iCollectValues= TRUE)
Returns an array of CATAnalysisCharacCollector describing the occurrences values.
Parameters:
oNbCharacCollectors
The number of CATAnalysisCharacCollector objects.
oCharacCollectors
An array of CATAnalysisCharacCollector objects.
o GetCollectorArchiver
protected HRESULT GetCollectorArchiver( const CATSamPhysicalType iPhysicalType,
const CATSamCharacVersion& iVersion,
const CATString& iPosition,
CATAnalysisCollectorArchiver*& oGetCollectorArchiver)
Returns the associated collector archiver.
Parameters:
iPhysicalType
The physical type
iVersion
The version object.
iPosition
The position identifier.
oGetCollectorArchiver
The CATAnalysisCollectorArchiver object.
o GetContext
public virtual HRESULT GetContext(CATAnalysisExplicitParent& oContext)
Return the Context.
Parameters:
oContext
The Context is the explicit set or entity that represent the feature that implement the interface.
o GetContextModel
public virtual HRESULT GetContextModel( const CATAnalysisExplicitModel*& oModelContext)
Gets context Model for collect. Returns the context for wich the CATAnalysisCharacCollector 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
Returns the current occurrence number for the current set. This method must be redefined.
Parameters:
oOccurrenceNumber
The occurrence number.
o GetNumberOfOccurrences
public virtual HRESULT GetNumberOfOccurrences(int& oNumberOfOccurrences) = 0
Returns the list of occurrences for the current set. This method must be redefined.
Parameters:
oNumberOfOccurrences
The number of occurrences.
o IsAnAvailableDefinition
public virtual HRESULT IsAnAvailableDefinition( const CATSamPhysicalType iPhysicalType,
const CATSamCharacVersion& iVersion,
const CATString& iPosition,
CATBoolean& oIsCollectable)
Asks to the implementing feature if a definition of a CATAnalysisCharacCollector is available. Note that a complete definition means physical type, version and position identifier.
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 IsAuthorizedToArchiveCollectors
protected virtual HRESULT IsAuthorizedToArchiveCollectors(CATBoolean& oCanArchive) const
Get Collector archiving autorization. This method should be redefined to allow collector archiving.
Parameters:
oCanArchive

Legal values:
  • TRUE Allow the archiving.
  • FALSE Deny the archiving. This is the default value.
o SetCollectorArchiver
protected HRESULT SetCollectorArchiver( const CATSamPhysicalType iPhysicalType,
const CATSamCharacVersion& iVersion,
const CATString& iPosition,
CATAnalysisCollectorArchiver* iSetCollectorArchiver)
Assigns the associated collector archiver.
Parameters:
iPhysicalType
The physical type
iVersion
The version object.
iPosition
The position identifier.
iSetCollectorArchiver
The CATAnalysisCollectorArchiver object. Note: If iSetCollectorArchiver is NULL, this will remove
the CATAnalysisCollectorArchiver associated to the definition.
o SetContextModel
public virtual HRESULT SetContextModel( const CATAnalysisExplicitModel* iModelContext)
Sets context Model for collect. Defines the context for wich the CATAnalysisCharacCollector 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
Sets the current occurrence number for the current set. This method must be redefined.
Parameters:
iOccurrenceNumber
The occurrence number.
o Update
public virtual HRESULT Update(CATBoolean iFullUpdate= TRUE)
Update internal data. This method can be redefined, in this case, this adpter must be called.

This object is included in the file: CATECharacCollector.h
If needed, your Imakefile.mk should include the module: CATAnalysisResources

Copyright © 2003, Dassault Systèmes. All rights reserved.