Dtk_KinMechanism Class Reference

Dtk_KinMechanism represents a kinematic mechanism. More...

Inheritance diagram for Dtk_KinMechanism:

Public Member Functions
void	addCommand (Dtk_KinCommandPtr inCmd)
	Add a command at the command table. More...
void	addJoint (Dtk_KinJointPtr inJoint)
	Add a joint at the joint table. More...
void	addLaw (Dtk_KinLawPtr inLaw)
	Add inLaw at the law table. More...
void	addSpeedAcceleration (Dtk_KinSpeedAccelerationPtr inSpeed)
	Add inSpeed at the speed/acceleration at the speed/acceleration table. More...
void	deleteLaw (Dtk_KinLawPtr inLaw)
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 mechanism. More...
type_detk	get_type_detk () const
Dtk_KinCommandPtr	getCommand (Dtk_Size_t inPos)
	Returns Dtk_KinCommand at position inPos. More...
Dtk_Size_t	getCommandSize ()
	Return the attribute tab size. More...
Dtk_KinFixPartPtr	getFixPart ()
	Returns the fix part object. More...
int	getId ()
	Returns the mechanism id. More...
Dtk_KinJointPtr	getJoint (Dtk_Size_t inPos)
	Returns Dtk_KinJoint at position inPos. More...
Dtk_Size_t	getJointSize ()
	Return the attribute tab size. More...
Dtk_KinLawPtr	getLaw (Dtk_Size_t inPos)
	Returns Dtk_KinLaw at position inPos. More...
Dtk_Size_t	getLawSize ()
	Return the attribute tab size. More...
Dtk_string	getName ()
	Returns the mechanism name. More...
Dtk_KinParameterPtr	getParamTime ()
	Returns the time parameter More...
virtual Dtk_Size_t	GetSize () const
Dtk_KinSpeedAccelerationPtr	getSpeedAcceleration (Dtk_Size_t inPos)
	Returns Dtk_KinSpeedAcceleration at position inPos. More...
Dtk_Size_t	getSpeedAccelerationSize ()
	Return the attribute tab size. More...
Dtk_string	getVersion ()
	Returns the mechanism version. More...
Dtk_bool	hasCommand (Dtk_KinCommandPtr inCmd)
	Test if the command belong at command table. More...
Dtk_bool	hasJoint (Dtk_KinJointPtr inJoint)
	Test if the joint belong at joint table. More...
Dtk_bool	hasLaw (Dtk_KinLawPtr inLaw)
	Test if the law belong at law table. More...
Dtk_bool	hasSpeedAcceleration (Dtk_KinSpeedAccelerationPtr inSpeed)
	Test if the speed/acceleration belong at speed/acceleration table. More...
Dtk_bool	isEqual (Dtk_KinMechanismPtr inMechanism)
	Test if 2 Dtk_KinMechanism is equal. More...
Dtk_bool	operator== (Dtk_KinMechanism &inMechanism)
	Test if 2 Dtk_KinMechanism is equal. More...
void	setFixPart (Dtk_KinFixPartPtr inFixPart)
	Sets the fix part. More...
void	setId (int inId)
	Sets the mechanism id. More...
void	setName (Dtk_string inName)
	Sets the mechanism name. More...
void	setParamTime (Dtk_KinParameterPtr inParam)
	Sets the time parameter. More...
void	setVersion (Dtk_string inVersion)
	Sets the mechanism version. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)

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

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

Protected Member Functions
	Dtk_KinMechanism ()
	Default constructor. More...
	Dtk_KinMechanism (const Dtk_KinMechanism &mecha)
	Copy constructor. More...
	~Dtk_KinMechanism ()
	Destructor. More...

Protected Attributes
Dtk_KinCommandTab	_cmdList
	All commands are defined into the kinematic command table. More...
Dtk_KinFixPartPtr	_fixPart
int	_ID
Dtk_KinJointTab	_jointList
	All joints are defined into the kinematic joint table. More...
Dtk_KinLawTab	_laws
Dtk_KinParameterPtr	_mechParamTime
Dtk_string	_name
Dtk_KinSpeedAccelerationTab	_speedAcc
Dtk_string	_version
unsigned long	count_

Detailed Description

Dtk_KinMechanism represents a kinematic mechanism.

A mechanism is linked at a kinematic object.

See also

Use Dtk_KinMechanismPtr 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_MECHANISM
          };

Constructor & Destructor Documentation

Dtk_KinMechanism() [1/2]

Dtk_KinMechanism::Dtk_KinMechanism ( )

protected

Default constructor.

Dtk_KinMechanism() [2/2]

Dtk_KinMechanism::Dtk_KinMechanism ( const Dtk_KinMechanism &  mecha )

protected

Copy constructor.

Parameters

mecha

the Dtk_KinMechanism to be copied

~Dtk_KinMechanism()

Dtk_KinMechanism::~Dtk_KinMechanism ( )

protected

Destructor.

Member Function Documentation

addCommand()

void Dtk_KinMechanism::addCommand

(

Dtk_KinCommandPtr

inCmd

)

Add a command at the command table.

Parameters

inCmd

command to be added

addJoint()

void Dtk_KinMechanism::addJoint

(

Dtk_KinJointPtr

inJoint

)

Add a joint at the joint table.

Parameters

inJoint

joint to be added

addLaw()

void Dtk_KinMechanism::addLaw

(

Dtk_KinLawPtr

inLaw

)

Add inLaw at the law table.

Parameters

inLaw

law to be added

If the law table doesn't contain inLaw, inLaw is added

addSpeedAcceleration()

void Dtk_KinMechanism::addSpeedAcceleration

(

Dtk_KinSpeedAccelerationPtr

inSpeed

)

Add inSpeed at the speed/acceleration at the speed/acceleration table.

Parameters

inSpeed

speed/acceleration to be added

Create()

static Dtk_KinMechanismPtr Dtk_KinMechanism::Create ( )

static

Calls default constructor to allocate a new object.

deleteLaw()

void Dtk_KinMechanism::deleteLaw

(

Dtk_KinLawPtr

inLaw

)

DtkDynamicCast()

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

static

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

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_KinMechanism::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_KinMechanism::Dump

(

FILE *

inFile

)

Write Dump file for mechanism.

Parameters

inFile

the output file

Sample

Dtk_string fileName = ...;
File * file = fileName.ouvrir_fichier(DTK_W);
 
Dtk_KinMechanism mechanism;
mechanism.setName(Dtk_string("sample mechanism"));
mechanism.setId(1);
mechanism.Dump(file);

Result

<mechanism name="sample mechanism" id="1" version="">
  <parts>
    <!-- Parts associated at mechanism -->
    <!-- part.Dump(inFile, true)  -->
  </parts>
  <commands>
    <!-- Commands associated at mechanism -->
    <!-- commands.Dump(inFile, true)  -->
  </commands>
  <!-- specfix.Dump(inFile) -->
  <paramTime>
    <!-- paramTime.Dump(inFile) -->
  </paramTime>
  <laws>
    <!-- law.Dump(inFile) -->
  </laws>
</mechanism>

get_type_detk()

type_detk Dtk_KinMechanism::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_KIN_MECHANISM -

{ return DTK_TYPE_KIN_MECHANISM; }

getCommand()

Dtk_KinCommandPtr Dtk_KinMechanism::getCommand

(

Dtk_Size_t

inPos

)

Returns Dtk_KinCommand at position inPos.

Parameters

inPos

position of element

If position is out bounds, returns

NULL 

getCommandSize()

Dtk_Size_t Dtk_KinMechanism::getCommandSize

(

)

Return the attribute tab size.

getFixPart()

Dtk_KinFixPartPtr Dtk_KinMechanism::getFixPart

(

)

Returns the fix part object.

getId()

int Dtk_KinMechanism::getId

(

)

Returns the mechanism id.

getJoint()

Dtk_KinJointPtr Dtk_KinMechanism::getJoint

(

Dtk_Size_t

inPos

)

Returns Dtk_KinJoint at position inPos.

Parameters

inPos

position of element

If position is out bounds, returns NULL

getJointSize()

Dtk_Size_t Dtk_KinMechanism::getJointSize

(

)

Return the attribute tab size.

getLaw()

Dtk_KinLawPtr Dtk_KinMechanism::getLaw

(

Dtk_Size_t

inPos

)

Returns Dtk_KinLaw at position inPos.

Parameters

inPos

position of element

If position is out bounds Returns NULL

getLawSize()

Dtk_Size_t Dtk_KinMechanism::getLawSize

(

)

Return the attribute tab size.

getName()

Dtk_string Dtk_KinMechanism::getName

(

)

Returns the mechanism name.

getParamTime()

Dtk_KinParameterPtr Dtk_KinMechanism::getParamTime

(

)

Returns the time 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.

getSpeedAcceleration()

Dtk_KinSpeedAccelerationPtr Dtk_KinMechanism::getSpeedAcceleration

(

Dtk_Size_t

inPos

)

Returns Dtk_KinSpeedAcceleration at position inPos.

Parameters

inPos

position of element

If position is out bounds returns NULL

getSpeedAccelerationSize()

Dtk_Size_t Dtk_KinMechanism::getSpeedAccelerationSize

(

)

Return the attribute tab size.

getVersion()

Dtk_string Dtk_KinMechanism::getVersion

(

)

Returns the mechanism version.

hasCommand()

Dtk_bool Dtk_KinMechanism::hasCommand

(

Dtk_KinCommandPtr

inCmd

)

Test if the command belong at command table.

Parameters

inCmd

command to be tested

hasJoint()

Dtk_bool Dtk_KinMechanism::hasJoint

(

Dtk_KinJointPtr

inJoint

)

Test if the joint belong at joint table.

Parameters

inJoint

joint to be tested

hasLaw()

Dtk_bool Dtk_KinMechanism::hasLaw

(

Dtk_KinLawPtr

inLaw

)

Test if the law belong at law table.

Parameters

inLaw

law to be tested

hasSpeedAcceleration()

Dtk_bool Dtk_KinMechanism::hasSpeedAcceleration

(

Dtk_KinSpeedAccelerationPtr

inSpeed

)

Test if the speed/acceleration belong at speed/acceleration table.

Parameters

inSpeed

speed/acceleration to be tested

isEqual()

Dtk_bool Dtk_KinMechanism::isEqual

(

Dtk_KinMechanismPtr

inMechanism

)

Test if 2 Dtk_KinMechanism is equal.

Compare the id attributes.

Parameters

inMechanism

Dtk_KinMechanism to be tested

operator==()

Dtk_bool Dtk_KinMechanism::operator==

(

Dtk_KinMechanism &

inMechanism

)

Test if 2 Dtk_KinMechanism is equal.

Compare the id attributes.

Parameters

inMechanism

Dtk_KinMechanism to be tested

release()

static Dtk_KinMechanismPtr Dtk_KinMechanism::release ( Dtk_KinMechanismPtr  inMechanism )

static

Delete object.

setFixPart()

void Dtk_KinMechanism::setFixPart

(

Dtk_KinFixPartPtr

inFixPart

)

Sets the fix part.

Parameters

inSpecfix

fix part

setId()

void Dtk_KinMechanism::setId

(

int

inId

)

Sets the mechanism id.

Parameters

inId	mechanism id

setName()

void Dtk_KinMechanism::setName

(

Dtk_string

inName

)

Sets the mechanism name.

Parameters

inName

mechanism name

setParamTime()

void Dtk_KinMechanism::setParamTime

(

Dtk_KinParameterPtr

inParam

)

Sets the time parameter.

Parameters

inParam

time parameter

setVersion()

void Dtk_KinMechanism::setVersion

(

Dtk_string

inVersion

)

Sets the mechanism version.

Parameters

inVersion

mechanism version

Transform()

Dtk_ErrorStatus Dtk_KinMechanism::Transform

(

const Dtk_transfo &

inTransfo

)

Field Documentation

_cmdList

Dtk_KinCommandTab Dtk_KinMechanism::_cmdList

protected

All commands are defined into the kinematic command table.

_fixPart

Dtk_KinFixPartPtr Dtk_KinMechanism::_fixPart

protected

_ID

int Dtk_KinMechanism::_ID

protected

_jointList

Dtk_KinJointTab Dtk_KinMechanism::_jointList

protected

All joints are defined into the kinematic joint table.

_laws

Dtk_KinLawTab Dtk_KinMechanism::_laws

protected

_mechParamTime

Dtk_KinParameterPtr Dtk_KinMechanism::_mechParamTime

protected

_name

Dtk_string Dtk_KinMechanism::_name

protected

_speedAcc

Dtk_KinSpeedAccelerationTab Dtk_KinMechanism::_speedAcc

protected

_version

Dtk_string Dtk_KinMechanism::_version

protected

count_

unsigned long Dtk_Object::count_

protectedinherited