All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATSamCharacVersion

CATAnalysisBase.CATSamExplicitRoot
  |
  +---CATSamCharacVersion
 

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


public class CATSamCharacVersion

Version information of a collector characteristic.

See also:
CATSamValue, CATSamMathType, CATSamRefFrame


Constructor and Destructor Index


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

Method Index


o CombineValues()
Combine the values of the collector (if possible) for entities which support repetitions.
o ComponentString(CATSamCharacVersion&,CATSamComponent)
Conversion of enumerated types CATSamComponent into strings (non NLS).
o ComponentString(CATSamCharacVersion&,CATSamComponent,CATUnicodeString&)
Conversion of enumerated types CATSamComponent into strings (non NLS).
o Dump(CATListValCATUnicodeString*,int)
Dumps the contents of the object.
o Dump(int)
Dumps the contents of the object.
o IsAKindOf(CATString&)
Test the type of the instance.
o IsMeshEntitiesCategory()
Test the category of the objects for which the collector characteristic has values.
o IsValid(CATSamValue,CATSamMathType,int)
Checks if the contents of the CATSamCharacVersion are compatible with a given mathematical description.
o operator =(CATSamCharacVersion&)
Assignment operator.
o operator!=(CATSamCharacVersion&)
Inequality operator.
o operator==(CATSamCharacVersion&)
Equality operator.

Data Member Index


o Category
The category of the objects for which the collector characteristic has values.
o Components
The components of the mathematical type.
o MathDimension
The mathematical dimension.
o MathType
The mathematical type.
o RefFrame
The type of reference frame.
o SubType
The subtype.
o ValueType
The type of value.
o ValuesAreCombined
The combination of the Values.

Constructor and Destructor


o CATSamCharacVersion
public CATSamCharacVersion()
Default constructor.
o CATSamCharacVersion
public CATSamCharacVersion( const CATSamCharacVersion& iVersion)
Copy constructor.
o ~CATSamCharacVersion
public virtual ~CATSamCharacVersion()
Destructor

Methods


o CombineValues
public CATBoolean CombineValues()const
Combine the values of the collector (if possible) for entities which support repetitions. The CombineValues is possible for a Type of Value : Real (exept for differents Local Axis), Double, Complex and ComplexDouble. AND the RefFrame must be a CATSamRefFrameGlobal.
o ComponentString
public static const char* ComponentString(CATSamCharacVersion& iVersion,
CATSamComponent iComponent)
Conversion of enumerated types CATSamComponent into strings (non NLS).
Parameters:
iVersion
The Context Version for the enumerated value which must be converted.
iComponent
The enumerated value which must be converted (0 <= iComponent < CATSamComponentLast).
Returns:
A string representing the enumerated value.
This string can be displayed to the user.
See also:
CATSamComponent
o ComponentString
public static void ComponentString(CATSamCharacVersion& iVersion,
CATSamComponent iComponent,
CATUnicodeString& oString)
Conversion of enumerated types CATSamComponent into strings (non NLS).
Parameters:
iVersion
The Context Version for the enumerated value which must be converted.
iComponent
The enumerated value which must be converted (0 <= iComponent < CATSamComponentLast).
oString
A CATUnicodeString representing the enumerated value.
This CATUnicodeString can be displayed to the user.
See also:
CATUnicodeString, CATSamComponent
o Dump
public void Dump(CATListValCATUnicodeString* oListOfString,
int iIndent= 0) const
Dumps the contents of the object.
Parameters:
oListOfString
The List of CATUnicodeString.
iIndent
The indentation level (one level represents 3 spaces).
o Dump
public void Dump(int iIndent= 0) const
Dumps the contents of the object.
Parameters:
iIndent
The indentation level (one level represents 3 spaces).
o IsAKindOf
public CATBoolean IsAKindOf( const CATString& iType) const
Test the type of the instance. Return True if iType = CATSamCharacVersion
Parameters:
iType
The type to test.
o IsMeshEntitiesCategory
public CATBoolean IsMeshEntitiesCategory()const
Test the category of the objects for which the collector characteristic has values. Return True if Category equal CATSamValueNode, CATSamValueVirtualNode, CATSamValueElement or CATSamValueVirtualElement
o IsValid
public CATBoolean IsValid(CATSamValue iValueType,
CATSamMathType iMathType,
int iMathDimension) const
Checks if the contents of the CATSamCharacVersion are compatible with a given mathematical description.
Parameters:
iValueType
The type of value.
iMathType
The mathematical type.
iMathDimension
The mathematical dimension.
See also:
CATSamValue, CATSamMathType
o operator =
public CATSamCharacVersion operator =( const CATSamCharacVersion& iVersion)
Assignment operator.
o operator!=
public CATBoolean operator!=( const CATSamCharacVersion& iVersion) const
Inequality operator. Used to check if two CATSamCharacVersion objects do not contain the same information
Parameters:
iVersion
A reference to the CATSamCharacVersion object to compare with.
o operator==
public CATBoolean operator==( const CATSamCharacVersion& iVersion) const
Equality operator. Used to check if two CATSamCharacVersion objects contain the same information.
Parameters:
iVersion
A reference to the CATSamCharacVersion object to compare with.

Data Members


o Category
  public CATSamValue Category
The category of the objects for which the collector characteristic has values.
o Components
  public CATSamComponent Components
The components of the mathematical type.
o MathDimension
  public int MathDimension
The mathematical dimension. .
o MathType
  public CATSamMathType MathType
The mathematical type. .
o RefFrame
  public CATSamRefFrame RefFrame
The type of reference frame.. .
o SubType
  public CATString SubType
The subtype.
o ValueType
  public CATSamValue ValueType
The type of value. .
o ValuesAreCombined
  public CATBoolean ValuesAreCombined
The combination of the Values.

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

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