Dtk_KinProduct Class Reference

Dtk_KinProduct represents a kinematic product. More...

Inheritance diagram for Dtk_KinProduct:

Public Member Functions
void	addPart (Dtk_KinPartPtr inPart)
	Adds the part. More...
void	addProduct (Dtk_KinProductPtr inProduct)
	Adds the product. 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, int &inNum)
	Write Dump file for product. More...
Dtk_string &	fileName ()
	\ brief Accessor for the file name attribute More...
type_detk	get_type_detk () const
Dtk_Size_t	getNbPart ()
	Returns the number of part associated. More...
Dtk_Size_t	getNbProduct ()
	Returns the part by it numChild attribute. More...
Dtk_KinPartPtr	getPart (Dtk_Size_t inPos)
	Returns the part at position inPos. More...
Dtk_KinProductPtr	getProduct (Dtk_Size_t inPos)
	Returns the product at position inPos. More...
virtual Dtk_Size_t	GetSize () const
int &	id ()
	Accessor for the id attribute. More...
Dtk_string &	instanceName ()
	Accessor for the instance name attribute. More...
Dtk_string &	name ()
	Accessor for the name attribute. More...
int &	numChild ()
	Accessor for the numChild attribute. More...
Dtk_KinProductPtr	searchProductByNumChild (int inNumChild)
	Returns the product by it numChild attribute. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)

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

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

Protected Member Functions
	Dtk_KinProduct ()
	Default constructor. More...
	Dtk_KinProduct (const Dtk_KinProduct &inProd)
	Copy constructor. More...
	~Dtk_KinProduct ()
	Destructor. More...

Protected Attributes
Dtk_string	_fileName
int	_ID
Dtk_string	_instanceName
Dtk_string	_name
int	_numChild
Dtk_KinPartTab	_parts
Dtk_KinProductTab	_products
unsigned long	count_

Detailed Description

Dtk_KinProduct represents a kinematic product.

See also

Use Dtk_KinProductPtr 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_PRODUCT
          };

Constructor & Destructor Documentation

Dtk_KinProduct() [1/2]

Dtk_KinProduct::Dtk_KinProduct ( )

protected

Default constructor.

Dtk_KinProduct() [2/2]

Dtk_KinProduct::Dtk_KinProduct ( const Dtk_KinProduct &  inProd )

protected

Copy constructor.

Parameters

part	the Dtk_KinPart to be copied

~Dtk_KinProduct()

Dtk_KinProduct::~Dtk_KinProduct ( )

protected

Destructor.

Member Function Documentation

addPart()

void Dtk_KinProduct::addPart

(

Dtk_KinPartPtr

inPart

)

Adds the part.

addProduct()

void Dtk_KinProduct::addProduct

(

Dtk_KinProductPtr

inProduct

)

Adds the product.

Create()

static Dtk_KinProductPtr Dtk_KinProduct::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

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

static

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

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_KinProduct::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_KinProduct::Dump	(	FILE *	inFile,
		int &	inNum
	)

Write Dump file for product.

Parameters

inFile

the output file

Sample

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

<product name="sample product" id="1" instanceName="...">
  <components>
    <!-- Products associated at this product -->
    <!-- product.Dump(inFile)  -->
    <!-- Parts associated at this product -->
    <!-- part.Dump(inFile, false)  -->
  </components>
</product>

fileName()

Dtk_string& Dtk_KinProduct::fileName

(

)

\ brief Accessor for the file name attribute

get_type_detk()

type_detk Dtk_KinProduct::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_KIN_PRODUCT -

{ return DTK_TYPE_KIN_PRODUCT; }

getNbPart()

Dtk_Size_t Dtk_KinProduct::getNbPart

(

)

Returns the number of part associated.

getNbProduct()

Dtk_Size_t Dtk_KinProduct::getNbProduct

(

)

Returns the part by it numChild attribute.

getPart()

Dtk_KinPartPtr Dtk_KinProduct::getPart

(

Dtk_Size_t

inPos

)

Returns the part at position inPos.

getProduct()

Dtk_KinProductPtr Dtk_KinProduct::getProduct

(

Dtk_Size_t

inPos

)

Returns the product at position inPos.

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.

id()

int& Dtk_KinProduct::id

(

)

Accessor for the id attribute.

instanceName()

Dtk_string& Dtk_KinProduct::instanceName

(

)

Accessor for the instance name attribute.

name()

Dtk_string& Dtk_KinProduct::name

(

)

Accessor for the name attribute.

numChild()

int& Dtk_KinProduct::numChild

(

)

Accessor for the numChild attribute.

searchProductByNumChild()

Dtk_KinProductPtr Dtk_KinProduct::searchProductByNumChild

(

int

inNumChild

)

Returns the product by it numChild attribute.

Transform()

Dtk_ErrorStatus Dtk_KinProduct::Transform

(

const Dtk_transfo &

inTransfo

)

Field Documentation

_fileName

Dtk_string Dtk_KinProduct::_fileName

protected

_ID

int Dtk_KinProduct::_ID

protected

_instanceName

Dtk_string Dtk_KinProduct::_instanceName

protected

_name

Dtk_string Dtk_KinProduct::_name

protected

_numChild

int Dtk_KinProduct::_numChild

protected

_parts

Dtk_KinPartTab Dtk_KinProduct::_parts

protected

_products

Dtk_KinProductTab Dtk_KinProduct::_products

protected

count_

unsigned long Dtk_Object::count_

protectedinherited