Dtk_KinLaw Class Reference

Dtk_KinLaw represents a law associated at a command. More...

Inheritance diagram for Dtk_KinLaw:

Public Member Functions
void	addCurve (Dtk_KinCurvePtr inCurve)
	Add a curve at the parameter in. More...
void	addParameter (Dtk_KinParameterPtr param)
	Add a paramater at the parameter table. More...
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
virtual int	DtkDynamicType (const int &inId)=0
virtual void	dump (FILE *file=stdout)
Dtk_status	Dump (FILE *inFile)
	Write Dump file for law. More...
type_detk	get_type_detk () const
int	getActive ()
	Returns the active attribute. More...
int	getAlgo ()
Dtk_string	getComment ()
	Returns the law comment. More...
Dtk_KinCurvePtr	getCurve (Dtk_Size_t inPos)
	Returns the curve at the position inPos. More...
Dtk_Size_t	getCurveSize ()
	Return the size of the curve tab. More...
Dtk_KinFormulaPtr	getExpression ()
	Returns the law expression (formula) More...
int	getId ()
	Returns the law id. More...
Dtk_string	getName ()
	Returns the law name. More...
Dtk_KinParameterTab	getParameter ()
	Returns the parameter table The last is the out parameter. More...
virtual Dtk_Size_t	GetSize () const
int	getSynchrone ()
	Returns the synchrone attribute. More...
Dtk_bool	isEqual (Dtk_KinLawPtr inLaw)
	Test if 2 Dtk_KinLaw is equal. More...
void	setActive (int inActive)
	Sets the active attribute. More...
void	setAlgo (int inAlgo)
void	setComment (Dtk_string inComment)
	Sets the law comment. More...
void	setExpression (Dtk_KinFormulaPtr inExpression)
	Sets the formula. More...
void	setId (int inId)
	Sets the law id. More...
void	setName (Dtk_string inName)
	Sets the law name. More...
void	setParameter (Dtk_KinParameterTab inParamOut)
	Sets the parameter table. More...
void	setSynchrone (int inSynchrone)
	Sets the synchrone attribute. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)

Static Public Member Functions
static Dtk_KinLawPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_KinLaw *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...
static Dtk_KinLawPtr	release (Dtk_KinLawPtr inLaw)
	Delete object. More...

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_KIN_LAW }

Protected Member Functions
	Dtk_KinLaw ()
	Default constructor. More...
	Dtk_KinLaw (const Dtk_KinLaw &inLaw)
	Copy constructor. More...
	~Dtk_KinLaw ()
	Destructor. More...

Protected Attributes
int	_active
int	_algo
Dtk_string	_comment
Dtk_KinCurveTab	_curve
Dtk_KinFormulaPtr	_expression
int	_ID
Dtk_string	_name
Dtk_KinParameterTab	_param
int	_synchrone
unsigned long	count_

Detailed Description

Dtk_KinLaw represents a law associated at a command.

A law is linked at a mechanism object.

See also

Use Dtk_KinLawPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

               {
               _typeID = DTK_TYPE_KIN_LAW
          };

Constructor & Destructor Documentation

Dtk_KinLaw() [1/2]

Dtk_KinLaw::Dtk_KinLaw ( )

protected

Default constructor.

Dtk_KinLaw() [2/2]

Dtk_KinLaw::Dtk_KinLaw ( const Dtk_KinLaw &  inLaw )

protected

Copy constructor.

Parameters

inLaw

the Dtk_KinLaw to be copied

~Dtk_KinLaw()

Dtk_KinLaw::~Dtk_KinLaw ( )

protected

Destructor.

Member Function Documentation

addCurve()

void Dtk_KinLaw::addCurve

(

Dtk_KinCurvePtr

inCurve

)

Add a curve at the parameter in.

Parameters

inCurve

Curve to be added

addParameter()

void Dtk_KinLaw::addParameter

(

Dtk_KinParameterPtr

param

)

Add a paramater at the parameter table.

Parameters

param

Parameter to be added

Create()

static Dtk_KinLawPtr Dtk_KinLaw::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

static Dtk_KinLaw* Dtk_KinLaw::DtkDynamicCast ( Dtk_Object *  s )

static

Performs a dynamic cast - doesn't need RTTI -.

          { 
               if(s->DtkDynamicType(_typeID)) 
                    return static_cast<Dtk_KinLaw*>(s); 
               return NULL; 
          } 

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_KinLaw::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

          { 
               if (inId == _typeID)
               {
                    return 1; 
               }
               return Dtk_Object::DtkDynamicType(inId); 
          }

DtkDynamicType() [2/2]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId )

pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout )

virtualinherited

Dump()

Dtk_status Dtk_KinLaw::Dump

(

FILE *

inFile

)

Write Dump file for law.

Parameters

inFile

the output file

Sample

Dtk_string fileName = ...;
File * file = fileName.ouvrir_fichier(DTK_W);
 
Dtk_KinLaw law;
law.setName(Dtk_string("sample law"));
law.setId(1);
law.Dump(file, true);

Result

<law name="sample law" id="1">
  <attributLaw comment="" synchrone="" active="" algo=""/>
  <!-- formula.Dump(inFile) -->
  <parameters>
    <!-- parameter.Dump(inFile) -->
  </parameters>
</law>

get_type_detk()

type_detk Dtk_KinLaw::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_KIN_LAW -

{ return DTK_TYPE_KIN_LAW; }

getActive()

int Dtk_KinLaw::getActive

(

)

Returns the active attribute.

getAlgo()

int Dtk_KinLaw::getAlgo

(

)

getComment()

Dtk_string Dtk_KinLaw::getComment

(

)

Returns the law comment.

getCurve()

Dtk_KinCurvePtr Dtk_KinLaw::getCurve

(

Dtk_Size_t

inPos

)

Returns the curve at the position inPos.

Parameters

inPos

position of element

If position is out bounds returns NULL

getCurveSize()

Dtk_Size_t Dtk_KinLaw::getCurveSize

(

)

Return the size of the curve tab.

getExpression()

Dtk_KinFormulaPtr Dtk_KinLaw::getExpression

(

)

Returns the law expression (formula)

getId()

int Dtk_KinLaw::getId

(

)

Returns the law id.

getName()

Dtk_string Dtk_KinLaw::getName

(

)

Returns the law name.

getParameter()

Dtk_KinParameterTab Dtk_KinLaw::getParameter

(

)

Returns the parameter table The last is the out parameter.

GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.

getSynchrone()

int Dtk_KinLaw::getSynchrone

(

)

Returns the synchrone attribute.

isEqual()

Dtk_bool Dtk_KinLaw::isEqual

(

Dtk_KinLawPtr

inLaw

)

Test if 2 Dtk_KinLaw is equal.

Compare the id attributes.

Parameters

inPart

Dtk_KinLaw to be tested

release()

static Dtk_KinLawPtr Dtk_KinLaw::release ( Dtk_KinLawPtr  inLaw )

static

Delete object.

setActive()

void Dtk_KinLaw::setActive

(

int

inActive

)

Sets the active attribute.

Parameters

inActive

active attribute

setAlgo()

void Dtk_KinLaw::setAlgo

(

int

inAlgo

)

setComment()

void Dtk_KinLaw::setComment

(

Dtk_string

inComment

)

Sets the law comment.

Parameters

inComment

law comment

setExpression()

void Dtk_KinLaw::setExpression

(

Dtk_KinFormulaPtr

inExpression

)

Sets the formula.

Parameters

inExpression

formula

setId()

void Dtk_KinLaw::setId

(

int

inId

)

Sets the law id.

Parameters

inId

law id

setName()

void Dtk_KinLaw::setName

(

Dtk_string

inName

)

Sets the law name.

Parameters

inName

law name

setParameter()

void Dtk_KinLaw::setParameter

(

Dtk_KinParameterTab

inParamOut

)

Sets the parameter table.

Parameters

inParamOut

parameter table

setSynchrone()

void Dtk_KinLaw::setSynchrone

(

int

inSynchrone

)

Sets the synchrone attribute.

Parameters

inSynchrone

synchrone attribute

Transform()

Dtk_ErrorStatus Dtk_KinLaw::Transform

(

const Dtk_transfo &

inTransfo

)

Field Documentation

_active

int Dtk_KinLaw::_active

protected

value:

• 1: deactivate
• 2: activate

_algo

int Dtk_KinLaw::_algo

protected

_comment

Dtk_string Dtk_KinLaw::_comment

protected

_curve

Dtk_KinCurveTab Dtk_KinLaw::_curve

protected

_expression

Dtk_KinFormulaPtr Dtk_KinLaw::_expression

protected

_ID

int Dtk_KinLaw::_ID

protected

_name

Dtk_string Dtk_KinLaw::_name

protected

_param

Dtk_KinParameterTab Dtk_KinLaw::_param

protected

_synchrone

int Dtk_KinLaw::_synchrone

protected

count_

unsigned long Dtk_Object::count_

protectedinherited