All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATAnalysisExplicitCharac

CATAnalysisBase.CATAnalysisExplicitData
  |
  +---CATAnalysisBase.CATAnalysisExplicitChild
    |
    +---CATAnalysisExplicitCharac
 

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


public class CATAnalysisExplicitCharac

Field model characteristic.
This object is used to provide services linked to the field model characteristics.


Constructor and Destructor Index


o CATAnalysisExplicitCharac()
Default constructor.
o CATAnalysisExplicitCharac(CATAnalysisExplicitCharac&)
Copy constructor.
o CATAnalysisExplicitCharac(CATAnalysisExplicitData&)
Copy constructor.

Method Index


o CreateCharac(CATAnalysisExplicitModel*,CATSamPhysicalType,CATSamMathType,CATSamValue,int,int,CATSamValuesDistributionMode&)
Creates a characteristic in the field model.
o CreateCharac(CATAnalysisExplicitModel*,CATSamPhysicalType,CATSamValue)
Creates a characteristic in the field model.
o CreateCharac(CATAnalysisExplicitParent&,CATSamPhysicalType,CATSamMathType,CATSamValue,int,int,CATSamValuesDistributionMode&)
Creates a characteristic in the field model as the child of an other set or entity.
o CreateCharac(CATAnalysisExplicitParent&,CATSamPhysicalType,CATSamValue)
Creates a characteristic in the field model as the child of an other set or entity.
o GetDefinition(CATSamMathType&,CATSamValue&,int&,int&,CATSamValuesDistributionMode&)
Obtains the mathematical definition of a characteristic.
o GetMathematicalDimension(int&)
Obtains the mathematical dimension of a characteristic.
o GetMathematicalType(CATSamMathType&)
Obtains the mathematical type of a characteristic.
o GetReferencingAxisPhysicalTypeInContext(CATAnalysisExplicitEntity&,CATSamPhysicalType&)
o GetRepeat(int&,CATSamValuesDistributionMode&)
Obtains the repeat number of a characteristic and the values distribution mode.
o GetSize(int&)
Obtains the size in bytes of the contents of the characteristic.
o GetSize(int&,int&)
Obtains the size in bytes and the number of values of the contents of the characteristic.
o GetValueType(CATSamValue&)
Obtains the type of value of a characteristic.
o GetValues(type const*(&))
Gets an array of values.
o GetValues(type&)
Gets one value.
o GetValues(type*)
Gets an array of values.
o HasRepeatedValues()
Tells if the values stored are distributed or repeated.
o Init(CATAnalysisExplicitData&)
o IsVariable()
Tells if this characteristic is variable or not.
o Reset()
o SetDefinition(CATSamMathType,CATSamValue,int,int,CATSamValuesDistributionMode)
Changes the mathematical definition of a characteristic.
o SetMathematicalType(CATSamMathType)
Changes the mathematical type of a characteristic.
o SetValueType(CATSamValue)
Changes the type of value of a characteristic.
o SetValues(type const*)
Stores an array of values.
o SetValues(type)
Stores one value.
o _SetAndGetValues(CATMathComplex)
o operator =(CATAnalysisExplicitCharac&)
Assignment operator.
o operator =(CATAnalysisExplicitData&)
Assignment operator.

Constructor and Destructor


o CATAnalysisExplicitCharac
public CATAnalysisExplicitCharac()
Default constructor.
o CATAnalysisExplicitCharac
public CATAnalysisExplicitCharac( const CATAnalysisExplicitCharac& iCharac)
Copy constructor.
o CATAnalysisExplicitCharac
public CATAnalysisExplicitCharac( const CATAnalysisExplicitData& iData)
Copy constructor.
See also:
CATAnalysisExplicitData

Methods


o CreateCharac
public HRESULT CreateCharac( const CATAnalysisExplicitModel* iModel,
CATSamPhysicalType iPhysicalType,
CATSamMathType iMathematicalType,
CATSamValue iValueType,
int iMathematicalDimension,
int iRepeat= 1,
const CATSamValuesDistributionMode& iDistributionMode= CATSamValuesDistributionModeRepeated)
Creates a characteristic in the field model. WARNING since V5R15. Negative iRepeat is not allowed anymore. Use iDistributionMode parameter instead.
Parameters:
iModel
A pointer to the field model into which the characteristic will be created.
iPhysicalType
The physical type of the characteristic.
iMathematicalType
The mathematical type.
iValueType
The type of value.
iMathematicalDimension
The mathematical dimension.
iRepeat
The number of times the values are repeated. Must be positive.
iDistributionMode
The mode of distribution of the values.
See also:
CATAnalysisExplicitModel, CATSamPhysicalType, CATSamMathType, CATSamValue, CATSamValuesDistributionMode
o CreateCharac
public HRESULT CreateCharac( const CATAnalysisExplicitModel* iModel,
CATSamPhysicalType iPhysicalType,
CATSamValue iValueType= CATSamValueLast)
Creates a characteristic in the field model.
Parameters:
iModel
A pointer to the field model into which the characteristic will be created.
iPhysicalType
The physical type of the characteristic.
The mathematical definition is obtained from the rules of the field model.
iValueType
The type of value.
If equal to CATSamValueLast then the default value from the rules file will be taken.
See also:
CATAnalysisExplicitModel, CATSamPhysicalType, CATSamValue
o CreateCharac
public HRESULT CreateCharac( const CATAnalysisExplicitParent& iParent,
CATSamPhysicalType iPhysicalType,
CATSamMathType iMathematicalType,
CATSamValue iValueType,
int iMathematicalDimension,
int iRepeat= 1,
const CATSamValuesDistributionMode& iDistributionMode= CATSamValuesDistributionModeRepeated)
Creates a characteristic in the field model as the child of an other set or entity. WARNING since V5R15. Negative iRepeat is not allowed anymore. Use iDistributionMode parameter instead.
Parameters:
iParent
The parent of the characteristic which will be created.
iPhysicalType
The physical type of the characteristic.
iMathematicalType
The mathematical type.
iValueType
The type of value.
iMathematicalDimension
The mathematical dimension.
iRepeat
The number of times the values are repeated. Must be positive.
iDistributionMode
The mode of distribution of the values.
See also:
CATAnalysisExplicitParent, CATSamPhysicalType, CATSamMathType, CATSamValue, CATSamValuesDistributionMode
o CreateCharac
public HRESULT CreateCharac( const CATAnalysisExplicitParent& iParent,
CATSamPhysicalType iPhysicalType,
CATSamValue iValueType= CATSamValueLast)
Creates a characteristic in the field model as the child of an other set or entity.
Parameters:
iParent
The parent of the characteristic which will be created.
iPhysicalType
The physical type of the characteristic. The mathematical definition is obtained from the rules of the field model.
iValueType
The type of value.
If equal to CATSamValueLast then the default value from the rules file will be taken.
See also:
CATAnalysisExplicitParent
o GetDefinition
public HRESULT GetDefinition(CATSamMathType& oMathematicalType,
CATSamValue& oValueType,
int& oMathematicalDimension,
int& oRepeat,
CATSamValuesDistributionMode& oDistributionMode) const
Obtains the mathematical definition of a characteristic.
Parameters:
oMathematicalType
The mathematical type.
oValueType
The type of value.
oMathematicalDimension
The mathematical dimension.
oRepeat
The number of times the values are repeated. Is always Positive.
oDistributionMode
The values distribution mode.
See also:
CATSamMathType, CATSamValue, CATSamValuesDistributionMode
o GetMathematicalDimension
public HRESULT GetMathematicalDimension(int& oMathematicalDimension) const
Obtains the mathematical dimension of a characteristic.
Parameters:
oMathematicalDimension
The mathematical dimension.
o GetMathematicalType
public HRESULT GetMathematicalType(CATSamMathType& oMathematicalType) const
Obtains the mathematical type of a characteristic.
Parameters:
oMathematicalType
The mathematical type.
See also:
CATSamMathType
o GetReferencingAxisPhysicalTypeInContext
public HRESULT GetReferencingAxisPhysicalTypeInContext( const CATAnalysisExplicitEntity& iContext,
CATSamPhysicalType& oReferencingAxis) const
o GetRepeat
public HRESULT GetRepeat(int& oRepeat,
CATSamValuesDistributionMode& oDistributionMode) const
Obtains the repeat number of a characteristic and the values distribution mode.
Parameters:
oRepeat
The number of times the values are repeated (absolute value).
oRepeat
The mode of distribution of the values.
See also:
CATSamValuesDistributionMode
o GetSize
public HRESULT GetSize(int& oSizeInBytes) const
Obtains the size in bytes of the contents of the characteristic.
o GetSize
public HRESULT GetSize(int& oSizeInBytes,
int& oNumberOfValues) const
Obtains the size in bytes and the number of values of the contents of the characteristic.
o GetValueType
public HRESULT GetValueType(CATSamValue& oValueType) const
Obtains the type of value of a characteristic.
Parameters:
oValueType
The type of value.
See also:
CATSamValue
o GetValues
public HRESULT GetValues(type const*(&) oValues) const
Gets an array of values.
type can be:
  • char
  • short
  • int
  • float
  • double
  • void const *
  • CATSamExplicitPtr
  • CATMathComplexf
  • CATMathComplex
Parameters:
oValues
A pointer to the array of values stored in the object.
o GetValues
public HRESULT GetValues(type& oValue) const
Gets one value.
type can be:
  • char
  • short
  • int
  • float
  • double
  • void const *
  • CATSamExplicitPtr
  • CATMathComplexf
  • CATMathComplex
Parameters:
oValue
The value stored in the object.
o GetValues
public HRESULT GetValues(type* oValues) const
Gets an array of values.
type can be:
  • char
  • short
  • int
  • float
  • double
  • void const *
  • CATSamExplicitPtr
  • CATMathComplexf
  • CATMathComplex
Parameters:
oValues
A pointer to a memory area where the values will be copied.
oValues must point to a memory area big enough to store the values.
o HasRepeatedValues
public CATBoolean HasRepeatedValues()const
Tells if the values stored are distributed or repeated.
o Init
public virtual HRESULT Init( const CATAnalysisExplicitData& iData)
o IsVariable
public CATBoolean IsVariable()const
Tells if this characteristic is variable or not.
o Reset
public virtual void Reset()
o SetDefinition
public HRESULT SetDefinition(CATSamMathType iMathematicalType,
CATSamValue iValueType,
int iMathematicalDimension,
int iRepeat,
CATSamValuesDistributionMode iDistributionMode) const
Changes the mathematical definition of a characteristic.
The memory requirements to store the values must be identical.
Parameters:
iMathematicalType
The mathematical type.
iValueType
The type of value.
iMathematicalDimension
The mathematical dimension.
iRepeat
The number of times the values are repeated. Must be Positive.
iDistributionMode
The values distribution mode.
See also:
CATSamMathType, CATSamValue, CATSamValuesDistributionMode
o SetMathematicalType
public HRESULT SetMathematicalType(CATSamMathType iMathematicalType) const
Changes the mathematical type of a characteristic.
The memory requirements to store the values must be identical.
Parameters:
iMathematicalType
The mathematical type.
See also:
CATSamMathType
o SetValueType
public HRESULT SetValueType(CATSamValue iValueType) const
Changes the type of value of a characteristic.
The memory requirements to store the values must be identical.
Parameters:
iValueType
The type of value.
See also:
CATSamValue
o SetValues
public HRESULT SetValues(type const* iValues) const
Stores an array of values.
type can be:
  • char
  • short
  • int
  • float
  • double
  • void const *
  • CATSamExplicitPtr
  • CATMathComplexf
  • CATMathComplex
Parameters:
iValues
A pointer to the array of values to store.
o SetValues
public HRESULT SetValues(type iValue) const
Stores one value.
type can be:
  • char
  • short
  • int
  • float
  • double
  • void const *
  • CATSamExplicitPtr
  • CATMathComplexf
  • CATMathComplex
Parameters:
iValue
The value to store.
o _SetAndGetValues
public _SetValues1(type) _SetValues2(type) _GetValues1(type) _GetValues2(type) _GetValues3(type) _SetAndGetValues(char) _SetAndGetValues(short) _SetAndGetValues(int) _SetAndGetValues(float) _SetAndGetValues(double) _SetAndGetValues(void const *) _SetAndGetValues _SetAndGetValues(CATMathComplex ) private : friend class CATAnalysisExplicitServices
o operator =
public CATAnalysisExplicitCharac operator =( const CATAnalysisExplicitCharac& iCharac)
Assignment operator.
o operator =
public CATAnalysisExplicitCharac operator =( const CATAnalysisExplicitData& iData)
Assignment operator.
See also:
CATAnalysisExplicitData

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

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