DATAKIT API  V2025.1
Dtk_Properties Class Reference

This is the Dtk_Properties class. More...

+ Inheritance diagram for Dtk_Properties:

Public Member Functions

virtual void conv_ptr (Dtk_Properties **s)
 
 Dtk_Properties (const Dtk_Properties &p)
 
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_stringGetTitle () const
 Get the Title of the Property . More...
 
const Dtk_stringGetType () const
 Get the Type of the Property . More...
 
const Dtk_stringGetValue () 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
 
Dtk_Propertiesoperator= (const Dtk_Properties &p)
 
void SetAsBoolean ()
 
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 ()
 
static Dtk_PropertiesDtkDynamicCast (Dtk_Object *s)
 

Protected Types

enum  { _typeID = DTK_TYPE_OBJECT }
 

Protected Member Functions

void _copy (const Dtk_Object &s)
 
void _copy (const Dtk_Properties &s)
 
void _Init ()
 
void _init ()
 
void _reset ()
 
 Dtk_Properties ()
 
virtual ~Dtk_Properties ()
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Friends

class Dtk_SmartPtr< Dtk_Properties >
 

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 

Constructor & Destructor Documentation

◆ Dtk_Properties() [1/2]

Dtk_Properties::Dtk_Properties ( const Dtk_Properties p)

◆ Dtk_Properties() [2/2]

Dtk_Properties::Dtk_Properties ( )
protected

◆ ~Dtk_Properties()

virtual Dtk_Properties::~Dtk_Properties ( )
protectedvirtual

Member Function Documentation

◆ _copy() [1/2]

void Dtk_Object::_copy ( const Dtk_Object s)
protectedinherited

◆ _copy() [2/2]

void Dtk_Properties::_copy ( const Dtk_Properties s)
protected

◆ _Init()

void Dtk_Properties::_Init ( )
protected

◆ _init()

void Dtk_Object::_init ( )
protectedinherited

◆ _reset()

void Dtk_Properties::_reset ( )
protected

◆ conv_ptr()

virtual void Dtk_Properties::conv_ptr ( Dtk_Properties **  s)
virtual
435 {*s = this;}

◆ create()

static Dtk_PropertiesPtr Dtk_Properties::create ( )
static

◆ 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()

◆ 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

◆ operator=()

Dtk_Properties& Dtk_Properties::operator= ( const Dtk_Properties p)

◆ SetAsBoolean()

void Dtk_Properties::SetAsBoolean ( )

◆ 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 .

Friends And Related Function Documentation

◆ Dtk_SmartPtr< Dtk_Properties >

friend class Dtk_SmartPtr< Dtk_Properties >
friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_Properties::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited
DTK_TYPE_OBJECT
@ DTK_TYPE_OBJECT
Definition: define.h:464
Dtk_Object::_typeID
@ _typeID
Definition: dtk_object.hpp:13