Dtk_KinNamedValue Class Reference

Dtk_KinNamedValue represents a named value. More...

Inheritance diagram for Dtk_KinNamedValue:

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 named value. More...
type_detk	get_type_detk () const
Dtk_string	getName ()
	Returns the name of the value. More...
virtual Dtk_Size_t	GetSize () const
double	getValue ()
	Returns the value of the name. More...
void	setName (Dtk_string inName)
	Sets the name. More...
void	setValue (double inValue)
	Sets the value. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)

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

Protected Types
enum	{ _typeID = DTK_TYPE_KIN_NAMED_VALUE }

Protected Member Functions
	Dtk_KinNamedValue ()
	Default constructor. More...
	Dtk_KinNamedValue (const Dtk_KinNamedValue &att)
	Copy constructor. More...
	~Dtk_KinNamedValue ()
	Destructor. More...

Protected Attributes
Dtk_string	_name
double	_valeur
unsigned long	count_

Detailed Description

Dtk_KinNamedValue represents a named value.

A named value is associated at a parameter.

See also

Use Dtk_KinNamedValuePtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_KIN_NAMED_VALUE
     };

Constructor & Destructor Documentation

Dtk_KinNamedValue() [1/2]

Dtk_KinNamedValue::Dtk_KinNamedValue ( )

protected

Default constructor.

Dtk_KinNamedValue() [2/2]

Dtk_KinNamedValue::Dtk_KinNamedValue ( const Dtk_KinNamedValue &  att )

protected

Copy constructor.

Parameters

att	the Dtk_KinNamedValue to be copied

~Dtk_KinNamedValue()

Dtk_KinNamedValue::~Dtk_KinNamedValue ( )

protected

Destructor.

Member Function Documentation

Create()

static Dtk_KinNamedValuePtr Dtk_KinNamedValue::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

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

static

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

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_KinNamedValue::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_KinNamedValue::Dump

(

FILE *

inFile

)

Write Dump file for named value.

Parameters

inFile

the output file

Sample

Dtk_string fileName = ...;
File * file = fileName.ouvrir_fichier(DTK_W);
 
Dtk_KinNamedValue attribut;
attribut.setName(Dtk_string("sample named value"));
attribut.setValue(5.21);
attribut.Dump(file);

Result

<namedValue name="sample named value" value="5.210000"/>

get_type_detk()

type_detk Dtk_KinNamedValue::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_KINEMATICS -

{ return DTK_TYPE_KIN_NAMED_VALUE; }

getName()

Dtk_string Dtk_KinNamedValue::getName

(

)

Returns the name of the value.

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.

getValue()

double Dtk_KinNamedValue::getValue

(

)

Returns the value of the name.

release()

static Dtk_KinNamedValuePtr Dtk_KinNamedValue::release ( Dtk_KinNamedValuePtr  inNamedValue )

static

Delete object.

setName()

void Dtk_KinNamedValue::setName

(

Dtk_string

inName

)

Sets the name.

Parameters

inName

name

setValue()

void Dtk_KinNamedValue::setValue

(

double

inValue

)

Sets the value.

Parameters

inValue

Value

Transform()

Dtk_ErrorStatus Dtk_KinNamedValue::Transform

(

const Dtk_transfo &

inTransfo

)

Field Documentation

_name

Dtk_string Dtk_KinNamedValue::_name

protected

_valeur

double Dtk_KinNamedValue::_valeur

protected

count_

unsigned long Dtk_Object::count_

protectedinherited