All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisBase Class 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(CATAnalysisExplicitData&)
- Copy constructor.
- o
CATAnalysisExplicitCharac(CATAnalysisExplicitCharac&)
- Copy constructor.
- o
CATAnalysisExplicitCharac()
- Default constructor.
Method Index
- o
CreateCharac(CATAnalysisExplicitModel*,CATSamPhysicalType,CATSamValue)
- Creates a characteristic in the field model.
- o
CreateCharac(CATAnalysisExplicitParent&,CATSamPhysicalType,CATSamValue)
- Creates a characteristic in the field model as the child of an other set or entity.
- o
CreateCharac(CATAnalysisExplicitModel*,CATSamPhysicalType,CATSamMathType,CATSamValue,int,int,CATSamValuesDistributionMode&)
- 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
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*)
- Gets an array of values.
- o
GetValues(type&)
- Gets one value.
- o
GetValues(type const*(&))
- 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)
- Stores one value.
- o
SetValues(type const*)
- Stores an array of values.
- o
_SetAndGetValues(CATMathComplex)
-
- o
operator =(CATAnalysisExplicitData&)
- Assignment operator.
- o
operator =(CATAnalysisExplicitCharac&)
- Assignment operator.
Constructor and Destructor
o CATAnalysisExplicitCharac
| public CATAnalysisExplicitCharac( | const | iData) |
-
Copy constructor.
- See also:
- CATAnalysisExplicitData
o CATAnalysisExplicitCharac
| public CATAnalysisExplicitCharac( | const | iCharac) |
-
Copy constructor.
o CATAnalysisExplicitCharac
| public CATAnalysisExplicitCharac( | ) |
-
Default constructor.
Methods
o CreateCharac
| public CreateCharac( | const | iModel, |
| | iPhysicalType, |
| | 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 CreateCharac( | const | iParent, |
| | iPhysicalType, |
| | 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 CreateCharac
| public CreateCharac( | const | iModel, |
| | iPhysicalType, |
| | iMathematicalType, |
| | iValueType, |
| | iMathematicalDimension, |
| | iRepeat | = 1, |
| const | 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 CreateCharac( | const | iParent, |
| | iPhysicalType, |
| | iMathematicalType, |
| | iValueType, |
| | iMathematicalDimension, |
| | iRepeat | = 1, |
| const | 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 GetDefinition
| public GetDefinition( | | oMathematicalType, |
| | oValueType, |
| | oMathematicalDimension, |
| | oRepeat, |
| | oDistributionMode) |
-
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 GetMathematicalDimension( | | oMathematicalDimension) |
-
Obtains the mathematical dimension of a characteristic.
- Parameters:
-
- oMathematicalDimension
- The mathematical dimension.
o GetMathematicalType
| public GetMathematicalType( | | oMathematicalType) |
-
Obtains the mathematical type of a characteristic.
- Parameters:
-
- oMathematicalType
- The mathematical type.
- See also:
- CATSamMathType
o GetReferencingAxisPhysicalTypeInContext
| public GetReferencingAxisPhysicalTypeInContext( | const | iContext, |
| | oReferencingAxis) |
-
o GetRepeat
| public GetRepeat( | | oRepeat, |
| | oDistributionMode) |
-
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 GetSize( | | oSizeInBytes) |
-
Obtains the size in bytes of the contents of the characteristic.
o GetSize
| public GetSize( | | oSizeInBytes, |
| | oNumberOfValues) |
-
Obtains the size in bytes and the number of values of the contents of the characteristic.
o GetValueType
| public GetValueType( | | oValueType) |
-
Obtains the type of value of a characteristic.
- Parameters:
-
- oValueType
- The type of value.
- See also:
- CATSamValue
o GetValues
| public GetValues( | | oValues) |
-
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 GetValues
| public GetValues( | | oValue) |
-
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 GetValues( | | oValues) |
-
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 HasRepeatedValues
| public HasRepeatedValues( | ) |
-
Tells if the values stored are distributed or repeated.
o Init
| public virtual Init( | const | iData) |
-
o IsVariable
-
Tells if this characteristic is variable or not.
o Reset
-
o SetDefinition
| public SetDefinition( | | iMathematicalType, |
| | iValueType, |
| | iMathematicalDimension, |
| | iRepeat, |
| | iDistributionMode) |
-
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 SetMathematicalType( | | iMathematicalType) |
-
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 SetValueType( | | iValueType) |
-
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 SetValues( | | iValue) |
-
Stores one value.
type can be:
- char
- short
- int
- float
- double
- void const *
- CATSamExplicitPtr
- CATMathComplexf
- CATMathComplex
- Parameters:
-
- iValue
- The value to store.
o SetValues
| public SetValues( | | iValues) |
-
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 _SetAndGetValues
| public _SetAndGetValues( | | ) |
-
o operator =
| public operator =( | const | iData) |
-
Assignment operator.
- See also:
- CATAnalysisExplicitData
o operator =
| public operator =( | const | iCharac) |
-
Assignment operator.
This object is included in the file: CATAnalysisExplicitCharac.h
If needed, your Imakefile.mk should include the module: CATSAM0Explicit