All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisEntityCollector

CATAnalysisBase.CATAnalysisCollectorRoot
  |
  +---CATAnalysisEntityCollector
 

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


public class CATAnalysisEntityCollector

Field model Object to extract finite element entities.
This object can be considered as a CharacCollector whitout values. It represents a collection of finite element support defined as a CATSamValue and a Position string. It is used as the result of CATISamGroup interface.


Constructor and Destructor Index


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

Method Index


o CompareDefinition(CATSamValue&,CATString&)
Compares all the information defining the collector characteristic with another definition.
o Dump(CATListValCATUnicodeString*,int,int,int)
Dumps the contents of the entity collector.
o Dump(int,int,int)
Dumps the contents of the collector.
o GetDefinition(CATSamValue&,CATString&)
Returns the EntityCollector definition.
o GetExplicitPointers(int&,CATSamExplicitPtr*&,int*&)
Obtains the entities contained in the EntityCollector.
o GetPositionsPointers(int*&,int* const*&)
Obtains the position information per entity.
o SetDefinition(CATSamValue,CATString)
Assigns all the information defining the EntityCollector.
o SetExplicitPointers(int,CATSamExplicitPtr*,int*)
Assigns the entities contained in the EntityCollector.
o operator =(CATAnalysisCharacCollector*)
Assignement operator.
o operator =(CATAnalysisEntityCollector&)
Assignement operator.
o operator!=(CATAnalysisEntityCollector&)
Comparison of two EntityCollectors.
o operator&(CATAnalysisEntityCollector&)
Binary operations (And).
o operator-(CATAnalysisEntityCollector&)
Binary operations (Substraction).
o operator==(CATAnalysisEntityCollector&)
Comparison of two EntityCollectors.
o operator^(CATAnalysisEntityCollector&)
Binary operations (exclusive Or).
o operator|(CATAnalysisEntityCollector&)
Binary operations (Or).

Constructor and Destructor


o CATAnalysisEntityCollector
public CATAnalysisEntityCollector()
Default constructor.
o CATAnalysisEntityCollector
public CATAnalysisEntityCollector( const CATAnalysisEntityCollector& iEntityCollector)
Copy constructor.
o ~CATAnalysisEntityCollector
public virtual ~CATAnalysisEntityCollector()
Destructor.

Methods


o CompareDefinition
public CATBoolean CompareDefinition( const CATSamValue& iValue,
const CATString& iPosition) const
Compares all the information defining the collector characteristic with another definition.
Parameters:
iValue
The CATSamValue.
iPosition
The CATPositon.
o Dump
public virtual void Dump(CATListValCATUnicodeString* oListOfString,
int iIndent= 0,
int iRecurse= 1,
int iLoopSize= 10) const
Dumps the contents of the entity collector.
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.
Parameters:
iIndent
The indentation level (one level represents 3 spaces).
iRecurse
The number of recursion levels.
iLoopSize
The size of loops.
o GetDefinition
public HRESULT GetDefinition(CATSamValue& oValue,
CATString& oPosition) const
Returns the EntityCollector definition.
Parameters:
oValue
The category of collected objects.
See also:
CATSamValue
oPosition
Position type on collected objects.
o GetExplicitPointers
public HRESULT GetExplicitPointers(int& oNbExplicitPointers,
const CATSamExplicitPtr*& oExplicitPointers,
const int*& oPositions) const
Obtains the entities contained in the EntityCollector.
Parameters:
oNbExplicitPointers
Size of oExplicitPointers.
oExplicitPointers[oNbExplicitPointers]
A pointer to the table of pointers to the entities which are in the collection.
oPositions[oNbExplicitPointers]
A pointer to the table of position per entities which are in the collection.
o GetPositionsPointers
public HRESULT GetPositionsPointers( const int*& oPositionsSize,
const int* const*& oPositionsPointers) const
Obtains the position information per entity.
Parameters:
oPositionsSize[_NbEntities]
A pointer to the table of Number of Positions per Entity.
oPositionsPointers[_NbEntities]
A pointer to the table of Pointers to the Positions List. Both oPositionsSize and oPositionsPointers can be NULL, in this case each entite have the same position (0).
o SetDefinition
public HRESULT SetDefinition(CATSamValue iValue,
CATString iPosition)
Assigns all the information defining the EntityCollector.
Parameters:
iValue
The category of collected objects.
See also:
CATSamValue
iPosition
Position type on collected objects.
o SetExplicitPointers
public HRESULT SetExplicitPointers(int iNbExplicitPointers,
const CATSamExplicitPtr* iExplicitPointers,
const int* iPositions= NULL)
Assigns the entities contained in the EntityCollector.
Parameters:
iNbExplicitPointers
Size of iExplicitPointers.
iExplicitPointers[iNbExplicitPointers]
A pointer to the table of pointers to the entities which are in the collection.
A copy of the contents of the table will be made.
oPositions[oNbExplicitPointers]
A pointer to the table of position per entities which are in the collection.
This pointer can be NULL, it means that all entities have the same position equal to 0.
A copy of the contents of the table will be made.
o operator =
public CATAnalysisEntityCollector& operator =( const CATAnalysisCharacCollector* iCharacCollector)
Assignement operator.
o operator =
public CATAnalysisEntityCollector& operator =( const CATAnalysisEntityCollector& iEntityCollector)
Assignement operator.
o operator!=
public CATBoolean operator!=( const CATAnalysisEntityCollector& iEntityCollector)const
Comparison of two EntityCollectors.
Parameters:
iEntityCollector
the Collector to compare to.
o operator&
public CATAnalysisEntityCollector& operator&( const CATAnalysisEntityCollector& iEntiyCollector)
Binary operations (And).
o operator-
public CATAnalysisEntityCollector& operator-( const CATAnalysisEntityCollector& iEntiyCollector)
Binary operations (Substraction).
o operator==
public CATBoolean operator==( const CATAnalysisEntityCollector& iEntityCollector)const
Comparison of two EntityCollectors.
Parameters:
iEntityCollector
the Collector to compare to.
o operator^
public CATAnalysisEntityCollector& operator^( const CATAnalysisEntityCollector& iEntiyCollector)
Binary operations (exclusive Or).
o operator|
public CATAnalysisEntityCollector& operator|( const CATAnalysisEntityCollector& iEntiyCollector)
Binary operations (Or).

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

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