All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisBase Class CATSamDimension

CATAnalysisBase.CATSamExplicitRoot
  |
  +---CATSamDimension
 

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


public class CATSamDimension

Dimension information of a collector characteristic.
The values in a CATAnalysisCharacCollector are stored as follows :

Values[NbPositions][NbLamina][NbSMI][NbRepeat[IndexPosition][IndexLamina][IndexSmi]][NbComponents].
However NbRepeat can be variable with the Position, Lamina and SMI number.
Let us assume NbPositions=2, NbLamina=1, NbSMI=2 and NbComponents=2, with NbRepeat configured as follows :
NbRepeat[P1][L1][S1]=2, NbRepeat[P1][L1][S2]=1,
NbRepeat[P2][L1][S1]=0, NbRepeat[P2][L1][S2]=3.
The values in memory are stored as follows :
V[P1,L1,S1,C1], V[P1,L1,S1,C2], V[P1,L1,S1,C1], V[P1,L1,S1,C2], V[P1,L1,S2,C1], V[P1,L1,S2,C2],
V[P2,L1,S2,C1], V[P2,L1,S2,C2], V[P2,L1,S2,C1], V[P2,L1,S2,C2], V[P2,L1,S2,C1], V[P2,L1,S2,C2].
With :
V[Pi,Lj,Sk,Cl]) : the Value of the set of Position, Lamina , SMI and Component (Pi,Lj,Sk,Cl).
Pi : the Position index.
Lj : the Lamina index.
Sk : the SMI index.
Cl : the Component index.


Constructor and Destructor Index


o CATSamDimension()
Default constructor.
o CATSamDimension(CATSamDimension&)
Copy constructor
o CATSamDimension(int,int* const,int,int* const,int,int* const,int* const,int* const,CATSamAggregationMode* const,CATSamValue,CATSamMathType,int)
Creates a CATSamDimension object and fills it with the supplied values.
o CATSamDimension(int,int,int,int* const,CATSamValue,CATSamMathType,int)
Creates a CATSamDimension object and fills it with the supplied values.
o ~CATSamDimension()
Destructor.

Method Index


o Dump(CATListValCATUnicodeString*,int,int)
Dumps the contents of the CATSamDimension object.
o Dump(int,int)
Dumps the contents of the CATSamDimension object.
o Fill(int,int* const,int,int* const,int,int* const,int* const,int* const,CATSamAggregationMode* const,CATSamValue,CATSamMathType,int)
Fills a CATSamDimension object with the supplied values.
o Fill(int,int,int,int* const,CATSamValue,CATSamMathType,int)
Fills a CATSamDimension object with the supplied values.
o GetAggregationMode(int,int,int)
Get the Aggregation Mode of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
o GetComponents()
Get the Components of the CATSamDimension object.
o GetLaminates()
Get the Laminates of the CATSamDimension object.
o GetNbComponents()
Get the number of Components of the CATSamDimension object.
o GetNbLaminates()
Return the number of Laminates of the CATSamDimension object.
o GetNbPositions()
Return the number of Positions of the CATSamDimension object.
o GetNbRepeat(int,int,int)
Get the number of Repeat of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
o GetNbRepeatTotal()
Get the whole number of Repeat of the CATSamDimension object.
o GetNbSMI()
Return the number of positions within each laminate of the CATSamDimension object.
o GetNbValues()
Return the number of values of the CATSamDimension object.
o GetNbValues(int,int,int)
Return the number of collected values for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
o GetPositions()
Get the positions of the CATSamDimension object.
o GetRepeat(int,int,int)
Get the Repeat of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
o GetSMI()
Get the positions within each laminate of the CATSamDimension object.
o GetSizeValues()
Return the size of values of the CATSamDimension object.
o GetSizeValues(int,int,int)
Return the size of collected values for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
o GetUnitaryValueSize()
Get the value size of a Component.
o HadNegativeRepeat()
Obtain the Repeat configuration.
o HadVariableRepeat()
Obtain the Repeat configuration.
o IsAKindOf(CATString&)
Test the type of the instance.
o SetNbComponents(int,int* const)
Change the number of Components of the CATSamDimension object with the supplied values, and set the Components numbers.
o SetNbLaminates(int,int* const)
Change the number of Laminates of the CATSamDimension object with the supplied values and set the Laminates numbers.
o SetNbPositions(int,int* const)
Change the number of Positions of the CATSamDimension object with the supplied values and set the positions numbers.
o SetNbRepeat(int,int,int,int,int* const,CATSamAggregationMode* const)
Change the number of Repeat of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex) with the supplied values and set the Repeat numbers.
o SetNbSMI(int,int* const)
Change the number of positions within each laminate of the CATSamDimension object with the supplied values and set the SMI numbers.
o SetUnitaryValueSize(CATSamValue)
Change the size of a single value.
o SetUnitaryValueSize(int)
Change the value size of a Component.
o ValuesAddress(void*,int,int,int,int,int)
Compute the offset on Values Pointer according to the definition of the CATSamDimension object.
o operator =(CATSamDimension&)
Copies the contents of another CATSamDimension object.
o operator ==(CATSamDimension&)
Compare the contents of another CATSamDimension object to the current instance.

Data Member Index


o PublicWorkPtr
Give a public access to the Work field.

Constructor and Destructor


o CATSamDimension
public CATSamDimension()
Default constructor.
o CATSamDimension
public CATSamDimension( const CATSamDimension& iDimension)
Copy constructor
o CATSamDimension
public CATSamDimension(int iNbPositions,
const int* const iPositionsNumber,
int iNbLaminates,
const int* const iLaminatesNumber,
int iNbSMI,
const int* const iSMI,
const int* const iNbRepeats,
const int* const iRepeatsNumber,
const CATSamAggregationMode* const iAggregationMode,
CATSamValue iValueType,
CATSamMathType iMathType,
int iMathDimension)
Creates a CATSamDimension object and fills it with the supplied values.
Parameters:
iNbPositions
The number of positions.
iPositionsNumber[iNbPositions]
The positions number.
WARNING :: The size of the Array iPositionsNumber must be equal to iNbPositions.
If iPositionsNumber is NULL positions numbers are set to 0...iPositions-1.
iNbLaminates
The number of laminates.
iLaminatesNumber[iNbLamina]
The laminates number.
WARNING :: The size of the Array iLaminatesNumber must be equal to iNbLamina.
If iLaminatesNumber is NULL laminates numbers are set to 0...iNbLamina-1.
iNbSMI
The number of positions within each laminate.
iSMI[iNbSMI]
The positions number within each laminate.
WARNING :: The size of the Array iSMI must be equal to iNbSMI.
If iSMI is NULL SMI numbers are set to 0...iNbSMI-1.
WARNING :: SMI numbers must match to values of the enum CATSamApplyQualifier.
iNbRepeats[NbGlobalPositions]
The number of another form of repetition for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iNbRepeats must be equal to NbGlobalPositions.
With NbGlobalPositions = iNbPositions*iNbLaminates*iNbSMI.
iNbRepeat is valued as follow :
Nb(P0,L0,S0), Nb(P0,L0,S1), ..., Nb(P0,L0,Sk), Nb(P0,L1,S0), ......, Nb(P0,L1,Sk), ...., Nb(P0,Lj,S0), ......, Nb(P0,Lj,Sk)
Nb(P1,L0,S0), Nb(P1,L0,S1), ..., Nb(P1,L0,Sk), Nb(P1,L1,S0), ......, Nb(P1,L1,Sk), ...., Nb(P1,Lj,S0), ......, Nb(P1,Lj,Sk)
Nb(Pi,L0,S0), Nb(Pi,L0,S1), ..., Nb(Pi,L0,Sk), Nb(Pi,L1,S0), ......, Nb(Pi,L1,Sk), ...., Nb(Pi,Lj,S0), ......, Nb(Pi,Lj,Sk)
With :
Nb(Pi,Lj,Sk) : the repeat number of the set of Position, Lamina and SMI (Pi,Lj,Sk).
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
iRepeatsNumber[NbRepeatTotal]
The repetion number of another form of repetition for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iRepeatsNumber must be equal to NbRepeatTotal.
With NbRepeatTotal = iNbRepeat[0]+iNbRepeat[1]+..+iNbRepeat[NbGlobalPositions-1].
iRepeatsNumber is valued as follow :
R0(P0,L0,S0), R1(P0,L0,S0), ..., Rx(P0,L0,S0), R0(P0,L0,S1), ......, Rx(P0,L0,S1), ...., R0(P0,L0,Sk), ......, Rx(P0,L0,Sk)
R0(P0,L1,S0), R1(P0,L1,S0), ..., Rx(P0,L1,S0), R0(P0,L1,S1), ......, Rx(P0,L1,S1), ...., R0(P0,L1,Sk), ......, Rx(P0,L1,Sk)
R0(P0,Lj,S0), R1(P0,Lj,S0), ..., Rx(P0,Lj,S0), R0(P0,Lj,S1), ......, Rx(P0,Lj,S1), ...., R0(P0,Lj,Sk), ......, Rx(P0,Lj,Sk)
R0(P1,L0,S0), R1(P1,L0,S0), ..., Rx(P1,L0,S0), R0(P1,L0,S1), ......, Rx(P1,L0,S1), ...., R0(P1,L0,Sk), ......, Rx(P1,L0,Sk)
R0(P1,L1,S0), R1(P1,L1,S0), ..., Rx(P1,L1,S0), R0(P1,L1,S1), ......, Rx(P1,L1,S1), ...., R0(P1,L1,Sk), ......, Rx(P1,L1,Sk)
R0(P1,Lj,S0), R1(P1,Lj,S0), ..., Rx(P1,Lj,S0), R0(P1,Lj,S1), ......, Rx(P1,Lj,S1), ...., R0(P1,Lj,Sk), ......, Rx(P1,Lj,Sk)
R0(Pi,L0,S0), R1(Pi,L0,S0), ..., Rx(Pi,L0,S0), R0(Pi,L0,S1), ......, Rx(Pi,L0,S1), ...., R0(Pi,L0,Sk), ......, Rx(Pi,L0,Sk)
R0(Pi,L1,S0), R1(Pi,L1,S0), ..., Rx(Pi,L1,S0), R0(Pi,L1,S1), ......, Rx(Pi,L1,S1), ...., R0(Pi,L1,Sk), ......, Rx(Pi,L1,Sk)
R0(Pi,Lj,S0), R1(Pi,Lj,S0), ..., Rx(Pi,Lj,S0), R0(Pi,Lj,S1), ......, Rx(Pi,Lj,S1), ...., R0(Pi,Lj,Sk), ......, Rx(Pi,Lj,Sk)
With :
Rx(Pi,Lj,Sk) : the sequential number of the Entities which contribute to the collected values.
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
NB : Rx(Pi,Lj,Sk) = -1 if collected values are combined or if their origin are unknown.
If iRepeatsNumber is NULL repeat numbers are set to -1.
iAggregationMode[NbRepeatTotal]
The AggregationMode of the Characteristic values for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iAggregationMode must be equal to NbRepeatTotal.
With NbRepeatTotal = iNbRepeat[0]+iNbRepeat[1]+..+iNbRepeat[NbGlobalPositions-1].
iAggregationMode is valued as follow :
A0(P0,L0,S0), A1(P0,L0,S0), ..., Ax(P0,L0,S0), A0(P0,L0,S1), ......, Ax(P0,L0,S1), ...., A0(P0,L0,Sk), ......, Ax(P0,L0,Sk)
A0(P0,L1,S0), A1(P0,L1,S0), ..., Ax(P0,L1,S0), A0(P0,L1,S1), ......, Ax(P0,L1,S1), ...., A0(P0,L1,Sk), ......, Ax(P0,L1,Sk)
A0(P0,Lj,S0), A1(P0,Lj,S0), ..., Ax(P0,Lj,S0), A0(P0,Lj,S1), ......, Ax(P0,Lj,S1), ...., A0(P0,Lj,Sk), ......, Ax(P0,Lj,Sk)
A0(P1,L0,S0), A1(P1,L0,S0), ..., Ax(P1,L0,S0), A0(P1,L0,S1), ......, Ax(P1,L0,S1), ...., A0(P1,L0,Sk), ......, Ax(P1,L0,Sk)
A0(P1,L1,S0), A1(P1,L1,S0), ..., Ax(P1,L1,S0), A0(P1,L1,S1), ......, Ax(P1,L1,S1), ...., A0(P1,L1,Sk), ......, Ax(P1,L1,Sk)
A0(P1,Lj,S0), A1(P1,Lj,S0), ..., Ax(P1,Lj,S0), A0(P1,Lj,S1), ......, Ax(P1,Lj,S1), ...., A0(P1,Lj,Sk), ......, Ax(P1,Lj,Sk)
A0(Pi,L0,S0), A1(Pi,L0,S0), ..., Ax(Pi,L0,S0), A0(Pi,L0,S1), ......, Ax(Pi,L0,S1), ...., A0(Pi,L0,Sk), ......, Ax(Pi,L0,Sk)
A0(Pi,L1,S0), A1(Pi,L1,S0), ..., Ax(Pi,L1,S0), A0(Pi,L1,S1), ......, Ax(Pi,L1,S1), ...., A0(Pi,L1,Sk), ......, Ax(Pi,L1,Sk)
A0(Pi,Lj,S0), A1(Pi,Lj,S0), ..., Ax(Pi,Lj,S0), A0(Pi,Lj,S1), ......, Ax(Pi,Lj,S1), ...., A0(Pi,Lj,Sk), ......, Ax(Pi,Lj,Sk)
With :
Ax(Pi,Lj,Sk) : the AggregationMode of the Entities which contribute to the collected values.
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
NB : Ax(Pi,Lj,Sk) = CATSamAggregationModeAdd if collected values are combined or if their origin are unknown.
If iAggregationMode is NULL aggregation modes are set to CATSamAggregationModeAdd.
iValueType
The type of value (to calculate UnitaryValueSize).
iMathType
The mathematical type (to calculate NbValues).
iMathDimension
The mathematical dimension (to calculate NbValues).
See also:
CATSamValue, CATSamMathType, CATSamAggregationMode, CATSamApplyQualifier
o CATSamDimension
public CATSamDimension(int iNbPositions,
int iNbLaminates,
int iNbSMI,
const int* const iNbRepeats,
CATSamValue iValueType,
CATSamMathType iMathType,
int iMathDimension)
Creates a CATSamDimension object and fills it with the supplied values.
Parameters:
iNbPositions
The number of positions.
iNbLaminates
The number of laminates.
iNbSMI
The number of positions within each laminate.
iNbRepeats[NbGlobalPositions]
The number of another form of repetition for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iNbRepeats must be equal to NbGlobalPositions.
With NbGlobalPositions = iNbPositions*iNbLaminates*iNbSMI.
iNbRepeat is valued as follow :
Nb(P0,L0,S0), Nb(P0,L0,S1), ..., Nb(P0,L0,Sk), Nb(P0,L1,S0), ......, Nb(P0,L1,Sk), ...., Nb(P0,Lj,S0), ......, Nb(P0,Lj,Sk)
Nb(P1,L0,S0), Nb(P1,L0,S1), ..., Nb(P1,L0,Sk), Nb(P1,L1,S0), ......, Nb(P1,L1,Sk), ...., Nb(P1,Lj,S0), ......, Nb(P1,Lj,Sk)
Nb(Pi,L0,S0), Nb(Pi,L0,S1), ..., Nb(Pi,L0,Sk), Nb(Pi,L1,S0), ......, Nb(Pi,L1,Sk), ...., Nb(Pi,Lj,S0), ......, Nb(Pi,Lj,Sk)
With :
Nb(Pi,Lj,Sk) : the repeat number of the set of Position, Lamina and SMI (Pi,Lj,Sk).
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
iValueType
The type of value (to calculate UnitaryValueSize).
iMathType
The mathematical type (to calculate NbValues).
iMathDimension
The mathematical dimension (to calculate NbValues).
See also:
CATSamValue, CATSamMathType
o ~CATSamDimension
public virtual ~CATSamDimension()
Destructor.

Methods


o Dump
public void Dump(CATListValCATUnicodeString* oListOfString,
int iIndent= 0,
int iLoopSize= 10) const
Dumps the contents of the CATSamDimension object.
Parameters:
oListOfString
The List of CATUnicodeString.
iIndent
The indentation level (one level represents 3 spaces).
iLoopSize
The size of loops.
o Dump
public void Dump(int iIndent= 0,
int iLoopSize= 10) const
Dumps the contents of the CATSamDimension object.
Parameters:
iIndent
The indentation level (one level represents 3 spaces).
iLoopSize
The size of loops.
o Fill
public HRESULT Fill(int iNbPositions,
const int* const iPositionsNumber,
int iNbLaminates,
const int* const iLaminatesNumber,
int iNbSMI,
const int* const iSMI,
const int* const iNbRepeats,
const int* const iRepeatsNumber,
const CATSamAggregationMode* const iAggregationMode,
CATSamValue iValueType,
CATSamMathType iMathType,
int iMathDimension)
Fills a CATSamDimension object with the supplied values.
Parameters:
iNbPositions
The number of positions.
iPositionsNumber[iNbPositions]
The positions number.
WARNING :: The size of the Array iPositionsNumber must be equal to iNbPositions.
If iPositionsNumber is NULL positions numbers are set to 0...iPositions-1.
iNbLaminates
The number of laminates.
iLaminatesNumber[iNbLamina]
The laminates number.
WARNING :: The size of the Array iLaminatesNumber must be equal to iNbLamina.
If iLaminatesNumber is NULL laminates numbers are set to 0...iNbLamina-1.
iNbSMI
The number of positions within each laminate.
iSMI[iNbSMI]
The positions number within each laminate.
WARNING :: The size of the Array iSMI must be equal to iNbSMI.
If iSMI is NULL SMI numbers are set to 0...iNbSMI-1.
WARNING :: SMI numbers must match to values of the enum CATSamApplyQualifier.
iNbRepeats[NbGlobalPositions]
The number of another form of repetition for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iNbRepeats must be equal to NbGlobalPositions.
With NbGlobalPositions = iNbPositions*iNbLaminates*iNbSMI.
iNbRepeat is valued as follow :
Nb(P0,L0,S0), Nb(P0,L0,S1), ..., Nb(P0,L0,Sk), Nb(P0,L1,S0), ......, Nb(P0,L1,Sk), ...., Nb(P0,Lj,S0), ......, Nb(P0,Lj,Sk)
Nb(P1,L0,S0), Nb(P1,L0,S1), ..., Nb(P1,L0,Sk), Nb(P1,L1,S0), ......, Nb(P1,L1,Sk), ...., Nb(P1,Lj,S0), ......, Nb(P1,Lj,Sk)
Nb(Pi,L0,S0), Nb(Pi,L0,S1), ..., Nb(Pi,L0,Sk), Nb(Pi,L1,S0), ......, Nb(Pi,L1,Sk), ...., Nb(Pi,Lj,S0), ......, Nb(Pi,Lj,Sk)
With :
Nb(Pi,Lj,Sk) : the repeat number of the set of Position, Lamina and SMI (Pi,Lj,Sk).
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
iRepeatsNumber[NbRepeatTotal]
The repetion number of another form of repetition for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iRepeatsNumber must be equal to NbRepeatTotal.
With NbRepeatTotal = iNbRepeat[0]+iNbRepeat[1]+..+iNbRepeat[NbGlobalPositions-1].
iRepeatsNumber is valued as follow :
R0(P0,L0,S0), R1(P0,L0,S0), ..., Rx(P0,L0,S0), R0(P0,L0,S1), ......, Rx(P0,L0,S1), ...., R0(P0,L0,Sk), ......, Rx(P0,L0,Sk)
R0(P0,L1,S0), R1(P0,L1,S0), ..., Rx(P0,L1,S0), R0(P0,L1,S1), ......, Rx(P0,L1,S1), ...., R0(P0,L1,Sk), ......, Rx(P0,L1,Sk)
R0(P0,Lj,S0), R1(P0,Lj,S0), ..., Rx(P0,Lj,S0), R0(P0,Lj,S1), ......, Rx(P0,Lj,S1), ...., R0(P0,Lj,Sk), ......, Rx(P0,Lj,Sk)
R0(P1,L0,S0), R1(P1,L0,S0), ..., Rx(P1,L0,S0), R0(P1,L0,S1), ......, Rx(P1,L0,S1), ...., R0(P1,L0,Sk), ......, Rx(P1,L0,Sk)
R0(P1,L1,S0), R1(P1,L1,S0), ..., Rx(P1,L1,S0), R0(P1,L1,S1), ......, Rx(P1,L1,S1), ...., R0(P1,L1,Sk), ......, Rx(P1,L1,Sk)
R0(P1,Lj,S0), R1(P1,Lj,S0), ..., Rx(P1,Lj,S0), R0(P1,Lj,S1), ......, Rx(P1,Lj,S1), ...., R0(P1,Lj,Sk), ......, Rx(P1,Lj,Sk)
R0(Pi,L0,S0), R1(Pi,L0,S0), ..., Rx(Pi,L0,S0), R0(Pi,L0,S1), ......, Rx(Pi,L0,S1), ...., R0(Pi,L0,Sk), ......, Rx(Pi,L0,Sk)
R0(Pi,L1,S0), R1(Pi,L1,S0), ..., Rx(Pi,L1,S0), R0(Pi,L1,S1), ......, Rx(Pi,L1,S1), ...., R0(Pi,L1,Sk), ......, Rx(Pi,L1,Sk)
R0(Pi,Lj,S0), R1(Pi,Lj,S0), ..., Rx(Pi,Lj,S0), R0(Pi,Lj,S1), ......, Rx(Pi,Lj,S1), ...., R0(Pi,Lj,Sk), ......, Rx(Pi,Lj,Sk)
With :
Rx(Pi,Lj,Sk) : the sequential number of the Entities which contribute to the collected values.
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
NB : Rx(Pi,Lj,Sk) = -1 if collected values are combined or if their origin are unknown.
If iRepeatsNumber is NULL repeat numbers are set to -1.
iAggregationMode[NbRepeatTotal]
The AggregationMode of the Characteristic values for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iAggregationMode must be equal to NbRepeatTotal.
With NbRepeatTotal = iNbRepeat[0]+iNbRepeat[1]+..+iNbRepeat[NbGlobalPositions-1].
iAggregationMode is valued as follow :
A0(P0,L0,S0), A1(P0,L0,S0), ..., Ax(P0,L0,S0), A0(P0,L0,S1), ......, Ax(P0,L0,S1), ...., A0(P0,L0,Sk), ......, Ax(P0,L0,Sk)
A0(P0,L1,S0), A1(P0,L1,S0), ..., Ax(P0,L1,S0), A0(P0,L1,S1), ......, Ax(P0,L1,S1), ...., A0(P0,L1,Sk), ......, Ax(P0,L1,Sk)
A0(P0,Lj,S0), A1(P0,Lj,S0), ..., Ax(P0,Lj,S0), A0(P0,Lj,S1), ......, Ax(P0,Lj,S1), ...., A0(P0,Lj,Sk), ......, Ax(P0,Lj,Sk)
A0(P1,L0,S0), A1(P1,L0,S0), ..., Ax(P1,L0,S0), A0(P1,L0,S1), ......, Ax(P1,L0,S1), ...., A0(P1,L0,Sk), ......, Ax(P1,L0,Sk)
A0(P1,L1,S0), A1(P1,L1,S0), ..., Ax(P1,L1,S0), A0(P1,L1,S1), ......, Ax(P1,L1,S1), ...., A0(P1,L1,Sk), ......, Ax(P1,L1,Sk)
A0(P1,Lj,S0), A1(P1,Lj,S0), ..., Ax(P1,Lj,S0), A0(P1,Lj,S1), ......, Ax(P1,Lj,S1), ...., A0(P1,Lj,Sk), ......, Ax(P1,Lj,Sk)
A0(Pi,L0,S0), A1(Pi,L0,S0), ..., Ax(Pi,L0,S0), A0(Pi,L0,S1), ......, Ax(Pi,L0,S1), ...., A0(Pi,L0,Sk), ......, Ax(Pi,L0,Sk)
A0(Pi,L1,S0), A1(Pi,L1,S0), ..., Ax(Pi,L1,S0), A0(Pi,L1,S1), ......, Ax(Pi,L1,S1), ...., A0(Pi,L1,Sk), ......, Ax(Pi,L1,Sk)
A0(Pi,Lj,S0), A1(Pi,Lj,S0), ..., Ax(Pi,Lj,S0), A0(Pi,Lj,S1), ......, Ax(Pi,Lj,S1), ...., A0(Pi,Lj,Sk), ......, Ax(Pi,Lj,Sk)
With :
Ax(Pi,Lj,Sk) : the sequential number of the Entities which contribute to the collected values.
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
NB : Ax(Pi,Lj,Sk) = CATSamAggregationModeAdd if collected values are combined or if their origin are unknown.
If iAggregationMode is NULL aggregation modes are set to CATSamAggregationModeAdd.
iValueType
The type of value (to calculate UnitaryValueSize).
iMathType
The mathematical type (to calculate NbValues).
iMathDimension
The mathematical dimension (to calculate NbValues).
See also:
CATSamValue, CATSamMathType, CATSamAggregationMode, CATSamApplyQualifier
o Fill
public HRESULT Fill(int iNbPositions,
int iNbLaminates,
int iNbSMI,
const int* const iNbRepeats,
CATSamValue iValueType,
CATSamMathType iMathType,
int iMathDimension)
Fills a CATSamDimension object with the supplied values.
Parameters:
iNbPositions
The number of positions.
iNbLaminates
The number of laminates.
iNbSMI
The number of positions within each laminate.
iNbRepeats[NbGlobalPositions]
The number of another form of repetition for each set of Position, Lamina and SMI.
WARNING :: The size of the Array iNbRepeats must be equal to NbGlobalPositions.
With NbGlobalPositions = iNbPositions*iNbLaminates*iNbSMI.
iNbRepeat is valued as follow :
Nb(P0,L0,S0), Nb(P0,L0,S1), ..., Nb(P0,L0,Sk), Nb(P0,L1,S0), ......, Nb(P0,L1,Sk), ...., Nb(P0,Lj,S0), ......, Nb(P0,Lj,Sk)
Nb(P1,L0,S0), Nb(P1,L0,S1), ..., Nb(P1,L0,Sk), Nb(P1,L1,S0), ......, Nb(P1,L1,Sk), ...., Nb(P1,Lj,S0), ......, Nb(P1,Lj,Sk)
Nb(Pi,L0,S0), Nb(Pi,L0,S1), ..., Nb(Pi,L0,Sk), Nb(Pi,L1,S0), ......, Nb(Pi,L1,Sk), ...., Nb(Pi,Lj,S0), ......, Nb(Pi,Lj,Sk)
With :
Nb(Pi,Lj,Sk) : the repeat number of the set of Position, Lamina and SMI (Pi,Lj,Sk).
Pi : the Position index (between 0 and iNbPositions-1).
Lj : the Lamina index (between 0 and iNbLaminates-1).
Sk : the SMI index (between 0 and iNbSMI-1).
iValueType
The type of value (to calculate UnitaryValueSize).
iMathType
The mathematical type (to calculate NbValues).
iMathDimension
The mathematical dimension (to calculate NbValues).
See also:
CATSamValue, CATSamMathType
o GetAggregationMode
public const CATSamAggregationMode* GetAggregationMode(int iPositionIndex,
int iLaminaIndex,
int iSMIIndex) const
Get the Aggregation Mode of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
Parameters:
iPositionIndex
The Position index.
iLaminaIndex
The Lamina index.
iSMIIndex
The SMI index.
See also:
CATSamAggregationMode
o GetComponents
public const int* GetComponents()const
Get the Components of the CATSamDimension object.
o GetLaminates
public const int* GetLaminates()const
Get the Laminates of the CATSamDimension object.
o GetNbComponents
public int GetNbComponents()const
Get the number of Components of the CATSamDimension object.
o GetNbLaminates
public int GetNbLaminates()const
Return the number of Laminates of the CATSamDimension object.
o GetNbPositions
public int GetNbPositions()const
Return the number of Positions of the CATSamDimension object.
o GetNbRepeat
public int GetNbRepeat(int iPositionIndex,
int iLaminaIndex,
int iSMIIndex) const
Get the number of Repeat of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
Parameters:
iPositionIndex
The Position index.
iLaminaIndex
The Lamina index.
iSMIIndex
The SMI index.
o GetNbRepeatTotal
public int GetNbRepeatTotal()const
Get the whole number of Repeat of the CATSamDimension object.
Returns:
The whole number of Repeat of the CATSamDimension object computed as folow :
NbRepeatTotal = NbRepeat[0]+NbRepeat[1]+..+NbRepeat[NbGlobalPositions-1].
with NbGlobalPositions = iNbPositions*iNbLaminates*iNbSMI.
o GetNbSMI
public int GetNbSMI()const
Return the number of positions within each laminate of the CATSamDimension object.
o GetNbValues
public int GetNbValues()const
Return the number of values of the CATSamDimension object.
o GetNbValues
public int GetNbValues(int iPositionIndex,
int iLaminaIndex,
int iSMIIndex) const
Return the number of collected values for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
Parameters:
iPositionIndex
The Position index.
iLaminaIndex
The Lamina index.
iSMIIndex
The SMI index.
o GetPositions
public const int* GetPositions()const
Get the positions of the CATSamDimension object.
o GetRepeat
public const int* GetRepeat(int iPositionIndex,
int iLaminaIndex,
int iSMIIndex) const
Get the Repeat of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
Parameters:
iPositionIndex
The Position index.
iLaminaIndex
The Lamina index.
iSMIIndex
The SMI index.
o GetSMI
public const int* GetSMI()const
Get the positions within each laminate of the CATSamDimension object.
o GetSizeValues
public int GetSizeValues()const
Return the size of values of the CATSamDimension object.
o GetSizeValues
public int GetSizeValues(int iPositionIndex,
int iLaminaIndex,
int iSMIIndex) const
Return the size of collected values for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
Parameters:
iPositionIndex
The Position index.
iLaminaIndex
The Lamina index.
iSMIIndex
The SMI index.
o GetUnitaryValueSize
public int GetUnitaryValueSize()const
Get the value size of a Component.
o HadNegativeRepeat
public CATBoolean HadNegativeRepeat()const
Obtain the Repeat configuration.
Return True if Contain negative NbRepeat.
o HadVariableRepeat
public CATBoolean HadVariableRepeat()const
Obtain the Repeat configuration.
Return True if Contain variable Repeat.
o IsAKindOf
public CATBoolean IsAKindOf( const CATString& iType) const
Test the type of the instance. Return True if iType = CATSamDimension
Parameters:
iType
The type to test.
o SetNbComponents
public HRESULT SetNbComponents(int iNbComponents,
const int* const iComponents= NULL)
Change the number of Components of the CATSamDimension object with the supplied values, and set the Components numbers.
Parameters:
iNbComponents
The number of Components.
iComponents[iNbComponents]
The Components number. WARNING :: The size of the Array iComponents must be equal to iNbComponents.
If iComponents is NULL positions numbers are set to 0...iNbComponents-1.
o SetNbLaminates
public HRESULT SetNbLaminates(int iNbLaminates,
const int* const iLaminatesNumber= NULL)
Change the number of Laminates of the CATSamDimension object with the supplied values and set the Laminates numbers.
Parameters:
iNbLaminates
The number of laminates.
iLaminatesNumber[iNbLamina]
The laminates number.
WARNING :: The size of the Array iLaminatesNumber must be equal to iNbLamina.
If iLaminatesNumber is NULL laminates numbers are set to 0...iNbLamina-1.
o SetNbPositions
public HRESULT SetNbPositions(int iNbPositions,
const int* const iPositionsNumber= NULL)
Change the number of Positions of the CATSamDimension object with the supplied values and set the positions numbers.
Parameters:
iNbPositions
The number of positions.
iPositionsNumber[iNbPositions]
The positions number.
WARNING :: The size of the Array iPositionsNumber must be equal to iNbPositions.
If iPositionsNumber is NULL positions numbers are set to 0...iPositions-1. If iPositions is NULL positions numbers are set to 0...iPositions-1.
o SetNbRepeat
public HRESULT SetNbRepeat(int iPositionIndex,
int iLaminaIndex,
int iSMIIndex,
int iNbRepeats,
const int* const iRepeatsNumber= NULL,
const CATSamAggregationMode* const iAggregationMode= NULL)
Change the number of Repeat of the CATSamDimension object for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex) with the supplied values and set the Repeat numbers.
Parameters:
iPositionIndex
The Position number.
iLaminaIndex
The Lamina index.
iSMIIndex
The SMI number.
iNbRepeats
The number of Repetition for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
iRepeatsNumber[iNbRepeats]
The repetion numbers for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
WARNING :: The size of the Array iRepeatsNumber must be equal to iNbRepeats.
iRepeatsNumber is valued as follow :
R0, R1, ..., Rx.
with :
Rx : the sequential number of the Entities which contribute to the collected values.
NB : Rx = -1 if collected values are combined or if their origin are unknown.
If iRepeatsNumber is NULL repeat numbers are set to -1.
iAggregationMode[iNbRepeats]
The AggregationMode of the Characteristic values for the set of Position, Lamina and SMI (iPositionIndex, iLaminaIndex, iSMIIndex).
WARNING :: The size of the Array iAggregationMode must be equal to iNbRepeats.
iAggregationMode is valued as follow :
A0, A1, ..., Ax.
with :
Ax : the aggregation mode of the Entities which contribute to the collected values.
NB : Ax = CATSamAggregationModeAdd if collected values are combined or if their origin are unknown.
If iAggregationMode is NULL aggregation modes are set to CATSamAggregationModeAdd.
See also:
CATSamAggregationMode
o SetNbSMI
public HRESULT SetNbSMI(int iNbSMI,
const int* const iSMI= NULL)
Change the number of positions within each laminate of the CATSamDimension object with the supplied values and set the SMI numbers.
Parameters:
iNbSMI
The number of positions within each laminate.
iSMI[iNbSMI]
The positions number within each laminate.
WARNING :: The size of the Array iSMI must be equal to iNbSMI.
If iSMI is NULL SMI numbers are set to 0...iNbSMI-1.
WARNING :: SMI numbers must match to values of the enum CATSamApplyQualifier.
o SetUnitaryValueSize
public HRESULT SetUnitaryValueSize(CATSamValue iValueType)
Change the size of a single value. and set the Components numbers.
Parameters:
iValueType
The type of value (to calculate UnitaryValueSize).
iUnitaryValueSize
The Size of each Component.
o SetUnitaryValueSize
public HRESULT SetUnitaryValueSize(int iUnitaryValueSize)
Change the value size of a Component. and set the Components numbers.
Parameters:
iUnitaryValueSize
The Size of each Component.
o ValuesAddress
public const void* ValuesAddress( const void* iValuePointerBase,
int iPositionIndex,
int iLaminaIndex= 0,
int iSMIIndex= 0,
int iRepeatIndex= 0,
int iComponentIndex= 0) const
Compute the offset on Values Pointer according to the definition of the CATSamDimension object.
Parameters:
iValuePointerBase
The Pointer on Values.
iPositionIndex
The Position Index.
iLaminaIndex
The Lamina Index.
iSMIIndex
The SMI Index.
iRepeatIndex
The Repeat Index for the of Position and SMI [iPositionIndex, iSMIIndex].
iComponentIndex
The Component Index.
o operator =
public CATSamDimension operator =( const CATSamDimension& iDimension)
Copies the contents of another CATSamDimension object.
Parameters:
iDimension
The object which is to be copied.
o operator ==
public CATBoolean operator ==( const CATSamDimension& iDimension)
Compare the contents of another CATSamDimension object to the current instance.
Parameters:
iDimension
The object which is to be compared.

Data Members


o PublicWorkPtr
  public int * const PublicWorkPtr
Give a public access to the Work field.

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

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