All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ConstraintModeler Class CATMfPossibleCst

CATMfPossibleCst
 

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


public class CATMfPossibleCst


Deprecated:
V5R15 do not use Class representing a constraint definition. Role: A constraint definition can be used to create a constraint. Distance values are in millimeters, angle values are in degrees.
See also:
CATICst, CATICstFactory


Constructor and Destructor Index


o CATMfPossibleCst()
Constructs an empty constraint definition.
o CATMfPossibleCst(CATBaseUnknown_var&,CATBaseUnknown_var&,CATBaseUnknown_var&,CATICstData_var&,CATCstStatus,CATListOfCATUnicodeString,CATListOfCATUnicodeString,double,CATListOfDouble)
Constructs a constraint definition.
o CATMfPossibleCst(CATMfPossibleCst&)
Copy constructor.
o ~CATMfPossibleCst()

Method Index


o Dump()
Dumps the constraint definition.
o GetAttributes(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
Retrieves attributes names and attributes values.
o GetCstData()
Returns type.
o GetDistanceOrAngle()
Returns the first numerical value, a distance or an angle.
o GetDoubles()
Returns numerical values.
o GetElement(int)
Returns a constrained element.
o GetStatus()
Returns status.
o Read(CATICstData_var&,CATCstStatus&,double&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
Retrieves definition.

Constructor and Destructor


o CATMfPossibleCst
public CATMfPossibleCst()
Constructs an empty constraint definition.
o CATMfPossibleCst
public CATMfPossibleCst( const CATBaseUnknown_var& iElem1,
const CATBaseUnknown_var& iElem2,
const CATBaseUnknown_var& iElem3,
const CATICstData_var& iCstData,
const CATCstStatus iStatus,
const CATListOfCATUnicodeString iListOfAttributeNames,
const CATListOfCATUnicodeString iListOfAttributeValues,
const double iDistanceOrAngle=0,
const CATListOfDouble iListOfDoubles=NULL )
Constructs a constraint definition.
Parameters:
iElem1
The first element.
iElem2
The second element, equal to NULL_var if not defined.
iElem3
The third element, equal to NULL_var if not defined.
iCstData
The constraint type.
iStatus
The constraint status.
iListOfAttributeNames
The list of attribute names.
iListOfAttributeValues
The list of attribute values.
iDistanceOrAngle
The first numerical value, a distance or an angle.
iListOfDoubles
The list of numerical values.
o CATMfPossibleCst
public CATMfPossibleCst( const CATMfPossibleCst& iCst)
Copy constructor.
o ~CATMfPossibleCst
public ~CATMfPossibleCst()

Methods


o Dump
public int Dump()const
Dumps the constraint definition.
o GetAttributes
public void GetAttributes(CATListOfCATUnicodeString& oListOfAttributeNames,
CATListOfCATUnicodeString& oListOfAttributeValues) const
Retrieves attributes names and attributes values.
Parameters:
oListOfAttributeNames
The list of attributes names.
oListOfAttributeValues
The list of attributes values.
o GetCstData
public CATICstData_var GetCstData()const
Returns type.
o GetDistanceOrAngle
public double GetDistanceOrAngle()const
Returns the first numerical value, a distance or an angle.
o GetDoubles
public CATListOfDouble GetDoubles()const
Returns numerical values.
o GetElement
public CATBaseUnknown_var GetElement( const int iElemNumber) const
Returns a constrained element.
Parameters:
iElemNumber
The number of the element.
o GetStatus
public CATCstStatus GetStatus()const
Returns status.
o Read
public void Read(CATICstData_var& oCstData,
CATCstStatus& oStatus,
double& oDistanceOrAngle,
CATListOfCATUnicodeString& oListOfAttributeNames,
CATListOfCATUnicodeString& oListOfAttributeValues) const
Retrieves definition.
Parameters:
oCstData
The constraint type.
oStatus
The constraint status.
oDistancceOrAngle
The first numerical value, a distance or an angle.
oListOfAttributeNames
The list of attribute names.
oListOfAttributeValues
The list of attribute values.

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

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