Dtk_KinFixPart Class Reference

Dtk_KinFixPart represents the fixed part to simulate the mechanism. More...

Inheritance diagram for Dtk_KinFixPart:

Public Member Functions
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 fix part. More...
type_detk	get_type_detk () const
Dtk_KinConstraintPtr	getConstraint ()
	Returns the constraint associated to the fixed part. More...
int	getId ()
	Retrun the fix part id. More...
Dtk_string	getName ()
	Returns the fix part name. More...
Dtk_KinPartPtr	getPart ()
	Returns the part fixed. More...
virtual Dtk_Size_t	GetSize () const
void	setConstraint (Dtk_KinConstraintPtr inConstraint)
	Sets the constraint associated to the fixed part. More...
void	setId (int inId)
	Sets the fix part id. More...
void	setName (Dtk_string inName)
	Sets the fix part name. More...
void	setPart (Dtk_KinPartPtr inPart)
	Sets the part fixed. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)

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

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

Protected Member Functions
	Dtk_KinFixPart ()
	Default constructor. More...
	Dtk_KinFixPart (const Dtk_KinFixPart &fixPart)
	Copy constructor. More...
	~Dtk_KinFixPart ()
	Destructor. More...

Protected Attributes
Dtk_KinConstraintPtr	_fixcst
	This constraint is defined into the kinematic constraint table. More...
Dtk_KinPartPtr	_fixpart
	This part is defined into the kinematic part table. More...
int	_ID
Dtk_string	_name
unsigned long	count_

Detailed Description

Dtk_KinFixPart represents the fixed part to simulate the mechanism.

A fixed part is linked at a mechanism object.

See also

Use Dtk_KinFixPartPtr 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_FIXPART
          };

Constructor & Destructor Documentation

Dtk_KinFixPart() [1/2]

Dtk_KinFixPart::Dtk_KinFixPart ( )

protected

Default constructor.

Dtk_KinFixPart() [2/2]

Dtk_KinFixPart::Dtk_KinFixPart ( const Dtk_KinFixPart &  fixPart )

protected

Copy constructor.

Parameters

fixPart

the Dtk_KinFixPart to be copied

~Dtk_KinFixPart()

Dtk_KinFixPart::~Dtk_KinFixPart ( )

protected

Destructor.

Member Function Documentation

Create()

static Dtk_KinFixPartPtr Dtk_KinFixPart::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

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

static

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

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_KinFixPart::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_KinFixPart::Dump

(

FILE *

inFile

)

Write Dump file for fix part.

Parameters

inFile

the output file

Sample

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

Result

<part name="sample fixPart" id="1">
  <!-- Constraint associated at the fix part / constraint.Dump(inFile, true) -->
  <!-- Part associated at the fix part / part.Dump(inFile, true) -->
</part>

get_type_detk()

type_detk Dtk_KinFixPart::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_KIN_FIXPART -

{ return DTK_TYPE_KIN_FIXPART; }

getConstraint()

Dtk_KinConstraintPtr Dtk_KinFixPart::getConstraint

(

)

Returns the constraint associated to the fixed part.

getId()

int Dtk_KinFixPart::getId

(

)

Retrun the fix part id.

getName()

Dtk_string Dtk_KinFixPart::getName

(

)

Returns the fix part name.

getPart()

Dtk_KinPartPtr Dtk_KinFixPart::getPart

(

)

Returns the part fixed.

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.

release()

static Dtk_KinFixPartPtr Dtk_KinFixPart::release ( Dtk_KinFixPartPtr  inFixPart )

static

Delete object.

setConstraint()

void Dtk_KinFixPart::setConstraint

(

Dtk_KinConstraintPtr

inConstraint

)

Sets the constraint associated to the fixed part.

Parameters

inConstraint

fix part constraint

setId()

void Dtk_KinFixPart::setId

(

int

inId

)

Sets the fix part id.

Parameters

inId	fix part id

setName()

void Dtk_KinFixPart::setName

(

Dtk_string

inName

)

Sets the fix part name.

Parameters

inName

fix part name

setPart()

void Dtk_KinFixPart::setPart

(

Dtk_KinPartPtr

inPart

)

Sets the part fixed.

Parameters

inPart

Part to be fixed

Transform()

Dtk_ErrorStatus Dtk_KinFixPart::Transform

(

const Dtk_transfo &

inTransfo

)

Field Documentation

_fixcst

Dtk_KinConstraintPtr Dtk_KinFixPart::_fixcst

protected

This constraint is defined into the kinematic constraint table.

_fixpart

Dtk_KinPartPtr Dtk_KinFixPart::_fixpart

protected

This part is defined into the kinematic part table.

_ID

int Dtk_KinFixPart::_ID

protected

_name

Dtk_string Dtk_KinFixPart::_name

protected

count_

unsigned long Dtk_Object::count_

protectedinherited