Dtk_KinFormula Class Reference

Dtk_KinFormula represents the formula defined the law. More...

Inheritance diagram for Dtk_KinFormula:

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 formula. More...
type_detk	get_type_detk () const
Dtk_string	getComment ()
	Returns the formula comment. More...
Dtk_string	getFormula ()
	Returns the formula. More...
int	getId ()
	Returns the formula id. More...
Dtk_string	getName ()
	Returns the formula name. More...
Dtk_string	getParam ()
	Returns the formula parameter. More...
virtual Dtk_Size_t	GetSize () const
void	setComment (Dtk_string inComment)
	Sets the formula comment. More...
void	setFormula (Dtk_string inFormula)
	Sets the formula. More...
void	setId (int inId)
	Sets the formula id. More...
void	setName (Dtk_string inName)
	Sets the formula name. More...
void	setParam (Dtk_string inParam)
	Sets the formula parameter. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)

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

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

Protected Member Functions
	Dtk_KinFormula ()
	Default constructor. More...
	Dtk_KinFormula (const Dtk_KinFormula &inFormula)
	Copy constructor. More...
	~Dtk_KinFormula ()
	Destructor. More...

Protected Attributes
Dtk_string	_comment
Dtk_string	_formula
int	_ID
Dtk_string	_name
Dtk_string	_param
unsigned long	count_

Detailed Description

Dtk_KinFormula represents the formula defined the law.

A formula is linked at a law object.

See also

Use Dtk_KinFormulaPtr 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_FORMULA
          };

Constructor & Destructor Documentation

Dtk_KinFormula() [1/2]

Dtk_KinFormula::Dtk_KinFormula ( )

protected

Default constructor.

Dtk_KinFormula() [2/2]

Dtk_KinFormula::Dtk_KinFormula ( const Dtk_KinFormula &  inFormula )

protected

Copy constructor.

Parameters

inFormula

the Dtk_KinFormula to be copied

~Dtk_KinFormula()

Dtk_KinFormula::~Dtk_KinFormula ( )

protected

Destructor.

Member Function Documentation

Create()

static Dtk_KinFormulaPtr Dtk_KinFormula::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

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

static

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

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_KinFormula::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_KinFormula::Dump

(

FILE *

inFile

)

Write Dump file for formula.

Parameters

inFile

the output file

Sample

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

Result

<formula name="sample formula" id="1">
  <attributFormula comment="" formula="" parameter=""/>
</formula>

get_type_detk()

type_detk Dtk_KinFormula::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_KIN_FORMULA -

{ return DTK_TYPE_KIN_FORMULA; }

getComment()

Dtk_string Dtk_KinFormula::getComment

(

)

Returns the formula comment.

getFormula()

Dtk_string Dtk_KinFormula::getFormula

(

)

Returns the formula.

getId()

int Dtk_KinFormula::getId

(

)

Returns the formula id.

getName()

Dtk_string Dtk_KinFormula::getName

(

)

Returns the formula name.

getParam()

Dtk_string Dtk_KinFormula::getParam

(

)

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

release()

static Dtk_KinFormulaPtr Dtk_KinFormula::release ( Dtk_KinFormulaPtr  inFormula )

static

Delete object.

setComment()

void Dtk_KinFormula::setComment

(

Dtk_string

inComment

)

Sets the formula comment.

Parameters

inComment

formula comment

setFormula()

void Dtk_KinFormula::setFormula

(

Dtk_string

inFormula

)

Sets the formula.

Parameters

inFormula

formula

setId()

void Dtk_KinFormula::setId

(

int

inId

)

Sets the formula id.

Parameters

inId	formula id

setName()

void Dtk_KinFormula::setName

(

Dtk_string

inName

)

Sets the formula name.

Parameters

inName

formula name

setParam()

void Dtk_KinFormula::setParam

(

Dtk_string

inParam

)

Sets the formula parameter.

Parameters

inParam

formula parameter

Transform()

Dtk_ErrorStatus Dtk_KinFormula::Transform

(

const Dtk_transfo &

inTransfo

)

Field Documentation

_comment

Dtk_string Dtk_KinFormula::_comment

protected

_formula

Dtk_string Dtk_KinFormula::_formula

protected

_ID

int Dtk_KinFormula::_ID

protected

_name

Dtk_string Dtk_KinFormula::_name

protected

_param

Dtk_string Dtk_KinFormula::_param

protected

count_

unsigned long Dtk_Object::count_

protectedinherited