Dtk_Properties Class Reference

This is the Dtk_Properties class. More...

Inheritance diagram for Dtk_Properties:

Public Member Functions
int	DtkDynamicType (const int &inId)
virtual void	dump (FILE *file=stdout)
Dtk_string	GetFormula (Dtk_string &outEstimatedValue)
	Get the Formula and its Estimated value of the Property . More...
Dtk_ErrorStatus	GetFormula (Dtk_string &outFormula, Dtk_string &outEstimatedValue, Dtk_string &outTitle, Dtk_string &outResultType)
	Get the Formula Type of result and its Estimated value of the MetaData . More...
virtual Dtk_Size_t	GetSize () const
const Dtk_string &	GetTitle () const
	Get the Title of the Property . More...
const Dtk_string &	GetType () const
	Get the Type of the Property . More...
const Dtk_string &	GetValue () const
	Get the Value of the Property . More...
Dtk_bool	IsBoolean () const
Dtk_bool	IsDate () const
Dtk_bool	IsFormula () const
Dtk_bool	IsInteger () const
Dtk_bool	IsNull () const
Dtk_bool	IsReal () const
Dtk_bool	IsReference () const
Dtk_bool	IsString () const
void	SetAsBoolean ()
	SetAsDeprecated ("2026.4", "Use Create instead.") static Dtk_PropertiesPtr create()
void	SetAsInteger ()
void	SetAsReal ()
void	SetFormula (Dtk_string inFormula, Dtk_string inEstimatedValue, Dtk_string inTitle, Dtk_string inResultType)
	Set the MetaData as Formula . More...
void	SetTitle (Dtk_string)
	Set the Title of the Property . More...
void	SetType (Dtk_string in)
	Set the Type of the Property . More...
void	SetValue (Dtk_string)
	Set the Value of the Property . More...

Static Public Member Functions
static Dtk_PropertiesPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_PropertiesPtr	Create (const Dtk_Properties &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_Properties *	DtkDynamicCast (Dtk_Object *s)

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }

Protected Member Functions
virtual Dtk_Object *	Clone ()
	Dtk_Properties ()
	Dtk_Properties (const Dtk_Properties &)
	Dtk_Properties (Dtk_Properties &&) DTK_NOEXCEPT
virtual	~Dtk_Properties ()

Protected Attributes
std::unique_ptr< Dtk_Handle >	_Private
unsigned long	count_

Detailed Description

This is the Dtk_Properties class.

A Dtk_Properties contains the property which defines by its Type,Title and Value

This class lets you use Dtk_Properties.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

Constructor & Destructor Documentation

Dtk_Properties() [1/3]

Dtk_Properties::Dtk_Properties ( )

protected

Dtk_Properties() [2/3]

Dtk_Properties::Dtk_Properties ( const Dtk_Properties &  )

protected

See also

Create( const Dtk_Properties& in );

Dtk_Properties() [3/3]

Dtk_Properties::Dtk_Properties ( Dtk_Properties &&  )

protected

~Dtk_Properties()

virtual Dtk_Properties::~Dtk_Properties ( )

protectedvirtual

Member Function Documentation

Clone()

virtual Dtk_Object* Dtk_Properties::Clone ( )

protectedvirtual

     {
          return new Dtk_Properties( *this );
     }

Create() [1/2]

static Dtk_PropertiesPtr Dtk_Properties::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/2]

static Dtk_PropertiesPtr Dtk_Properties::Create ( const Dtk_Properties &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

DtkDynamicCast()

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

static

DtkDynamicType()

int Dtk_Properties::DtkDynamicType ( const int &  inId )

virtual

Implements Dtk_Object.

dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout )

virtualinherited

GetFormula() [1/2]

Dtk_string Dtk_Properties::GetFormula

(

Dtk_string &

outEstimatedValue

)

Get the Formula and its Estimated value of the Property .

Parameters

[out]

outEstimatedValue

: Estimated value of formula

Returns

the Value of this Property .

GetFormula() [2/2]

Dtk_ErrorStatus Dtk_Properties::GetFormula	(	Dtk_string &	outFormula,
		Dtk_string &	outEstimatedValue,
		Dtk_string &	outTitle,
		Dtk_string &	outResultType
	)

Get the Formula Type of result and its Estimated value of the MetaData .

Parameters

[out]	outEstimatedValue	: Estimated value of formula
[out]	outType	: Type of Estimated value

Returns

the Formula of this MetaData .

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.

GetTitle()

const Dtk_string& Dtk_Properties::GetTitle

(

)

const

Get the Title of the Property .

Returns

the Title of this Property .

GetType()

const Dtk_string& Dtk_Properties::GetType

(

)

const

Get the Type of the Property .

Returns

the Type of this Property .

GetValue()

const Dtk_string& Dtk_Properties::GetValue

(

)

const

Get the Value of the Property .

Returns

the Value of this Property .

IsBoolean()

Dtk_bool Dtk_Properties::IsBoolean

(

)

const

IsDate()

Dtk_bool Dtk_Properties::IsDate

(

)

const

IsFormula()

Dtk_bool Dtk_Properties::IsFormula

(

)

const

IsInteger()

Dtk_bool Dtk_Properties::IsInteger

(

)

const

IsNull()

Dtk_bool Dtk_Properties::IsNull

(

)

const

IsReal()

Dtk_bool Dtk_Properties::IsReal

(

)

const

IsReference()

Dtk_bool Dtk_Properties::IsReference

(

)

const

IsString()

Dtk_bool Dtk_Properties::IsString

(

)

const

SetAsBoolean()

void Dtk_Properties::SetAsBoolean

(

)

SetAsDeprecated()

Dtk_Properties::SetAsDeprecated	(	"2026.4"	,
		"Use Create instead."
	)

Deprecated:

Use Create instead.

SetAsInteger()

void Dtk_Properties::SetAsInteger

(

)

SetAsReal()

void Dtk_Properties::SetAsReal

(

)

SetFormula()

void Dtk_Properties::SetFormula	(	Dtk_string	inFormula,
		Dtk_string	inEstimatedValue,
		Dtk_string	inTitle,
		Dtk_string	inResultType
	)

Set the MetaData as Formula .

Parameters

[in]	inFormula	: Formula
[in]	inEstimatedValue	: Estimated value of formula
[in]	inResultType	: Type of the EstimateValue

Returns

the Formula of this MetaData .

SetTitle()

void Dtk_Properties::SetTitle

(

Dtk_string

)

Set the Title of the Property .

Returns

the Type of this Property .

SetType()

void Dtk_Properties::SetType

(

Dtk_string

in

)

Set the Type of the Property .

Returns

the Type of this Property .

SetValue()

void Dtk_Properties::SetValue

(

Dtk_string

)

Set the Value of the Property .

Returns

the Type of this Property .

Field Documentation

_Private

std::unique_ptr<Dtk_Handle> Dtk_Properties::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited