All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisCharacCollector

CATAnalysisBase.CATAnalysisCollectorRoot
  |
  +---CATAnalysisCharacCollector
 

Usage: you must use this class as is. You should never derive it.


public class CATAnalysisCharacCollector

A collector characteristic is a characteristic obtained by combining the information of basic characteristics over several entities.

To initialise a collector characteristic you must use the following methods in this order:

See also:
CATAnalysisExplicitParent, CATSamCharacVersion, CATSamDimension, CATSamAxis


Constructor and Destructor Index


o CATAnalysisCharacCollector()
Default constructor.
o CATAnalysisCharacCollector(CATAnalysisCharacCollector&)
Copy constructor.
o ~CATAnalysisCharacCollector()
Destructor.

Method Index


o CanCombineValues()
Check if the collector's values can be combined.
o CombineValues(CATAnalysisCharacCollector*,CATAnalysisCharacCollector*&,CATBoolean)
Combine the values of the collector for entities which support repetitions.
o CompareDefinition(CATSamPhysicalType,CATSamCharacVersion&,CATString&,int,CATSamPhysicalType)
Compares all the information defining the collector characteristic with another definition.
o Convert(CATSamCharacVersion&)
Converts the collector characteristic to a new version (if possible).
o Dump(CATListValCATUnicodeString*,int,int,int)
Dumps the contents of the collector characteristic.
o Dump(int,int,int)
Dumps the contents of the collector characteristic.
o GetCoordinateSystems(int&,CATSamAxis*&,CATSamAxis* const*&)
Obtains the coordinate system information per entity.
o GetDefinition(CATSamPhysicalType&,CATString&,CATSamCharacVersion&,CATString&,int&,CATSamPhysicalType&)
Obtains all the information defining the collector characteristic.
o GetDimensions(int&,CATSamDimension*&,CATSamDimension* const*&)
Obtains the dimension information per entity.
o GetFirstValuedEntity()
Obtains the first valued entity number.
o GetLastValuedEntity()
Obtains the last valued entity number.
o GetNbValuedEntities()
Obtains the number of valued entities.
o GetPositionUVWCoordinates(int&,float*&,float* const*&)
Obtains the UVW coordinates of the positions per entity.
o GetPositionXYZCoordinates(int*&,float*&,float*&)
Obtains the XYZ coordinates of the positions.
o GetValues(int&,int&,void* const*&)
Obtains the values of the collector characteristic.
o IsACoherentCollector()
Obtains a status on the coherency of this collector characteristic.
o IsCollectorContainValues()
Return if this collector characteristic contain values.
o IsStreamable()
Obtains the Streamable state of this collector characteristic.
o IsUpToDate()
Obtains the UpToDate state of this collector.
o IsValuedEntity(int)
Return TRUE if an Entity is Valued, FALSE otherwise.
o SetContext(CATAnalysisExplicitParent&,CATBoolean)
Assigns the context Set or Entity to which this collector belongs.
o SetCoordinateSystems(int,CATSamAxis*,CATSamAxis* const*)
Assigns the coordinate system information per entity.
o SetDefinition(CATSamPhysicalType,CATString&,CATSamCharacVersion&,CATString&,int,CATSamPhysicalType)
Assigns all the information defining the collector characteristic.
o SetDimensions(int,CATSamDimension*,CATSamDimension* const*)
Assigns the dimension information per entity.
o SetEntities(char*)
Assigns the entities for which the collector characteristic has values.
o SetNbEntities(int)
Sets the number of entities for which the collector characteristic has information.
o SetPositionUVWCoordinates(int,float*,float* const*)
Assigns the UVW coordinates of the positions per entity.
o SetPositionXYZCoordinates(int*,float*,float*)
Assigns the XYZ coordinates of the positions.
o SetStreamable(CATBoolean)
Assigns the Streamable state of this collector characteristic.
o SetValues(int,int,void*,void* const*)
Assigns the values of the collector characteristic.

Constructor and Destructor


o CATAnalysisCharacCollector
public CATAnalysisCharacCollector()
Default constructor.
o CATAnalysisCharacCollector
public CATAnalysisCharacCollector( const CATAnalysisCharacCollector& iCollector)
Copy constructor.
o ~CATAnalysisCharacCollector
public virtual ~CATAnalysisCharacCollector()
Destructor.

Methods


o CanCombineValues
public CATBoolean CanCombineValues()const
Check if the collector's values can be combined.
o CombineValues
public static HRESULT CombineValues( const CATAnalysisCharacCollector* iCollectorToCombine,
const CATAnalysisCharacCollector*& oCollectorCombined,
CATBoolean iAttachToModel= TRUE)
Combine the values of the collector for entities which support repetitions. The combined collector must be released after use.
Parameters:
iCollectorToCombine
A pointer to the collector to combine.
iCollectorToCombine
A pointer to the combined collector.
iAttacheToModel
The combined collector is attached or not in the Model.
iDuplicateCollector
The collector to combine is copied before being combined.
o CompareDefinition
public CATBoolean CompareDefinition(CATSamPhysicalType iPhysicalType,
const CATSamCharacVersion& iVersion,
const CATString& iPosition,
const int iOccurrenceNumber,
CATSamPhysicalType iEntityPhysicalType= CATSamPhysicalTypeNone) const
Compares all the information defining the collector characteristic with another definition.
Parameters:
iPhysicalType
The physical type.
iVersion
A pointer to the version information (a CATSamCharacVersion object).
iPosition
A pointer to the position type identifier.
The pre-defined positions are : NONE, NODE, DOF, ELEMENT, EDGE, FACE, CENTER, NODE_OF_ELEMENT and GAUSS.
iOccurrenceNumber
The occurrence number.
iEntityPhysicalType
The physical type of the Entity used to build collector (default all physical type are used).
See also:
CATSamCharacVersion
o Convert
public HRESULT Convert( const CATSamCharacVersion& iVersion)
Converts the collector characteristic to a new version (if possible).
Parameters:
iVersion
A pointer to the version information (a CATSamCharacVersion object).
See also:
CATSamCharacVersion
o Dump
public void Dump(CATListValCATUnicodeString* oListOfString,
int iIndent= 0,
int iRecurse= 1,
int iLoopSize= 10) const
Dumps the contents of the collector characteristic.
Parameters:
oListOfString
The List of CATUnicodeString.
iIndent
The indentation level (one level represents 3 spaces).
iRecurse
The number of recursion levels.
iLoopSize
The size of loops.
o Dump
public void Dump(int iIndent= 0,
int iRecurse= 1,
int iLoopSize= 10) const
Dumps the contents of the collector characteristic.
Parameters:
iIndent
The indentation level (one level represents 3 spaces).
iRecurse
The number of recursion levels.
iLoopSize
The size of loops.
o GetCoordinateSystems
public HRESULT GetCoordinateSystems(int& oNbAxes,
const CATSamAxis*& oAxes,
const CATSamAxis* const*& oAxisPointers) const
Obtains the coordinate system information per entity.
Parameters:
oNbAxes
The number of CATSamAxis objects (at least one).
oAxes[NbAxes]
A pointer to the table of CATSamAxis objects.
oAxisPointers[NbEntities]
A pointer to the table of pointers to the CATSamAxis objects for each entity.
If NULL, then all the entities use Axes[0].
See also:
CATSamAxis
o GetDefinition
public HRESULT GetDefinition(CATSamPhysicalType& oPhysicalType,
CATString& oUnit,
CATSamCharacVersion& oVersion,
CATString& oPosition,
int& oOccurrenceNumber,
CATSamPhysicalType& oEntityPhysicalType) const
Obtains all the information defining the collector characteristic.
Parameters:
oPhysicalType
The physical type.
oUnit
The unit category identifier.
oVersion
The version information (a CATSamCharacVersion object).
oPosition
The position type identifier.
The pre-defined positions are : NONE, NODE, DOF, ELEMENT, EDGE, FACE, CENTER, NODE_OF_ELEMENT and GAUSS.
oOccurrenceNumber
The occurrence number.
oEntityPhysicalType
The physical type of the Entity used to build collector.
See also:
CATSamCharacVersion
o GetDimensions
public HRESULT GetDimensions(int& oNbDimensions,
const CATSamDimension*& oDimensions,
const CATSamDimension* const*& oDimensionPointers) const
Obtains the dimension information per entity.
Parameters:
oNbDimensions
The number of CATSamDimension objects (at least one).
oDimensions[NbDimensions]
A pointer to the table of CATSamDimension objects.
oDimensionPointers[NbEntities]
A pointer to the table of pointers to the CATSamDimension objects for each entity.
If NULL, then all the entities use Dimensions[0].
See also:
CATSamDimension
o GetFirstValuedEntity
public virtual int GetFirstValuedEntity()const
Obtains the first valued entity number.
this methods should be called only after a call to
  • SetValues.
  • o GetLastValuedEntity
    public virtual int GetLastValuedEntity()const
    Obtains the last valued entity number.
    this methods should be called only after a call to
  • SetValues.
  • o GetNbValuedEntities
    public virtual int GetNbValuedEntities()const
    Obtains the number of valued entities.
    this methods should be called only after a call to
  • SetValues.
  • o GetPositionUVWCoordinates
    public HRESULT GetPositionUVWCoordinates(int& oNbUVW,
    const float*& oUVW,
    const float* const*& oUVWPointers) const
    Obtains the UVW coordinates of the positions per entity.
    Parameters:
    oNbUVW
    The number of different UVW positions.
    oUVW[3*NbUVW]
    A pointer to the different UVW positions.
    oUVWPointers[NbEntities]
    A pointer to the table of pointers to the UVW positions for each entity.
    o GetPositionXYZCoordinates
    public HRESULT GetPositionXYZCoordinates( const int*& oXYZPointers,
    const float*& oXYZPositions,
    const float*& oXYZDisplacements) const
    Obtains the XYZ coordinates of the positions.
    Parameters:
    oXYZPointers[NbElements+1]
    A pointer on a table of indices, in the XYZPositions and XYZDisplacements tables, of the first position for each element.
    oXYZPositions[XYZPointers[NbElements]]
    The XYZ coordinates of the positions before any displacement.
    oXYZDisplacements[XYZPointers[NbElements]]
    The XYZ displacement at each XYZ position.
    o GetValues
    public HRESULT GetValues(int& oNbValues,
    int& oSizeValues,
    const void* const*& oValuePointers) const
    Obtains the values of the collector characteristic.
    Parameters:
    oNbValues
    The total number of values.
    It is obtained by adding the number of values for each entity which has a non NULL entry in the ValuePointers table.
    In general is it NOT the same as the NbValues provided to the SetValues method.
    oSizeValues
    The total size in bytes of the values (= NbValues * sizeof(value type)).
    oValuePointers[NbEntities]
    A pointer to the table of pointers to the values for each entity.
    o IsACoherentCollector
    public CATBoolean IsACoherentCollector()const
    Obtains a status on the coherency of this collector characteristic. This method should be called before use a Collector.
    o IsCollectorContainValues
    public CATBoolean IsCollectorContainValues()const
    Return if this collector characteristic contain values. This method should be called before a call to th method GetValues.
    o IsStreamable
    public CATBoolean IsStreamable()const
    Obtains the Streamable state of this collector characteristic.
    o IsUpToDate
    public virtual CATBoolean IsUpToDate()const
    Obtains the UpToDate state of this collector.
    Inline Method.
    o IsValuedEntity
    public virtual CATBoolean IsValuedEntity(int iEntityNumber) const
    Return TRUE if an Entity is Valued, FALSE otherwise.
    this methods should be called only after a call to
  • SetValues.
    Parameters:
    iEntityNumber
    The entity number.
  • o SetContext
    public virtual HRESULT SetContext( const CATAnalysisExplicitParent& iContext,
    CATBoolean iAttachToModel= TRUE)
    Assigns the context Set or Entity to which this collector belongs.
    Parameters:
    iContext
    A reference to the explicit version of the context.
    iAttachToModel
    Indicates if the collector should be attached to the explicit model or not.
    See also:
    CATAnalysisExplicitParent
    o SetCoordinateSystems
    public virtual HRESULT SetCoordinateSystems(int iNbAxes,
    const CATSamAxis* iAxes,
    const CATSamAxis* const* iAxisPointers)
    Assigns the coordinate system information per entity.
    Parameters:
    iNbAxes
    The number of CATSamAxis objects (at least one).
    iAxes[NbAxes]
    A pointer to the table of CATSamAxis objects.
    A copy of the contents of the table will be made.
    iAxisPointers[NbEntities]
    A pointer to the table of pointers to the CATSamAxis objects for each entity.
    A copy of the contents of the table will be made.
    If NULL, then all the entities use Axes[0] and NbAxes must be equal to 1. All non NULL entries of this table must point to an entry in Axes.
    See also:
    CATSamAxis
    o SetDefinition
    public virtual HRESULT SetDefinition(CATSamPhysicalType iPhysicalType,
    const CATString& iUnit,
    const CATSamCharacVersion& iVersion,
    const CATString& iPosition,
    const int iOccurrenceNumber,
    CATSamPhysicalType iEntityPhysicalType= CATSamPhysicalTypeNone)
    Assigns all the information defining the collector characteristic.
    Parameters:
    iPhysicalType
    The physical type.
    iUnit
    The unit category identifier.
    iVersion
    The version information (a CATSamCharacVersion object).
    iPosition
    The position type identifier.
    The pre-defined positions are : NONE, NODE, DOF, ELEMENT, EDGE, FACE, CENTER, NODE_OF_ELEMENT and GAUSS.
    iOccurrenceNumber
    The occurrence number.
    iEntityPhysicalType
    The physical type of the Entity used to build collector (default all physical type are used).
    See also:
    CATSamCharacVersion
    o SetDimensions
    public virtual HRESULT SetDimensions(int iNbDimensions,
    const CATSamDimension* iDimensions,
    const CATSamDimension* const* iDimensionPointers)
    Assigns the dimension information per entity.
    Parameters:
    iNbDimensions
    The number of CATSamDimension objects (at least one).
    iDimensions[NbDimensions]
    A pointer to the table of CATSamDimension objects.
    A copy of the contents of the table will be made.
    iDimensionPointers[NbEntities]
    A pointer to the table of pointers to the CATSamDimension objects for each entity.
    A copy of the contents of the table will be made.
    If NULL, then all the entities use Dimensions[0] and NbDimensions must be equal to 1. All non NULL entries of this table must point to an entry in Dimensions.
    See also:
    CATSamDimension
    o SetEntities
    public virtual HRESULT SetEntities( const char* iEntityFlags)
    Assigns the entities for which the collector characteristic has values.
    Parameters:
    iEntityFlags[NbEntities]
    A pointer to the table of entity flags indicating which entities should have their values collected.
    A copy of the contents of the table will be made.
    o SetNbEntities
    public virtual HRESULT SetNbEntities(int iNbEntities= 0)
    Sets the number of entities for which the collector characteristic has information.
    Parameters:
    iNbEntities
    The number of entities.
    If 0, then the number is deduced from the context and the definition.
    o SetPositionUVWCoordinates
    public virtual HRESULT SetPositionUVWCoordinates(int iNbUVW,
    const float* iUVW,
    const float* const* iUVWPointers)
    Assigns the UVW coordinates of the positions per entity.
    Parameters:
    iNbUVW
    The number of different UVW positions.
    If 0, then UVWPointer must be non NULL.
    iUVW[3*NbUVW]
    A pointer to the different UVW positions.
    A copy of the contents of the table will be made.
    If NULL, then UVWPointer must be non NULL.
    iUVWPointers[NbEntities]
    A pointer to the table of pointers to the UVW positions for each entity.
    A copy of the contents of the table will be made.
    All non NULL entries of this table must point to an entry in UVW unless UVW is NULL.
    o SetPositionXYZCoordinates
    public virtual HRESULT SetPositionXYZCoordinates( const int* iXYZPointers,
    const float* iXYZPositions,
    const float* iXYZDisplacements)
    Assigns the XYZ coordinates of the positions.
    Parameters:
    iXYZPointers[NbElements+1]
    A pointer on a table of indices, in the XYZPositions and XYZDisplacements tables, of the first position for each element.
    iXYZPositions[XYZPointers[NbElements]]
    The XYZ coordinates of the positions before any displacement.
    iXYZDisplacements[XYZPointers[NbElements]]
    The XYZ displacement at each XYZ position.
    o SetStreamable
    public HRESULT SetStreamable(CATBoolean iIsStreamable)
    Assigns the Streamable state of this collector characteristic.
    Parameters:
    iIsStreamable
    The Streamable state.
    o SetValues
    public virtual HRESULT SetValues(int iNbValues,
    int iSizeValues,
    const void* iValues,
    const void* const* iValuePointers)
    Assigns the values of the collector characteristic.
    Parameters:
    iNbValues
    The number of values.
    iSizeValues
    The size in bytes of the values (= NbValues * sizeof(value type)).
    iValues[NbValues]
    A pointer to the memory location where the values are stored.
    A copy of the values will be made unless the pointer is NULL.
    If NULL, then ValuePointers is required.
    iValuePointers[NbEntities]
    A pointer to the table of pointers to the values for each entity.
    A copy of the contents of the table will be made unless the pointer is NULL.
    If NULL, then Values is required and ValuePointers will be created.
    Non NULL entries in this table are not required to point exclusively into the Values table.

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

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