Dtk_feat_user_defined_value Class Reference

Public Member Functions
	Dtk_feat_user_defined_value ()
	Dtk_feat_user_defined_value (const Dtk_feat_user_defined_value &inValue)
int	get_value_double (double &outValue)
	Get the User Defined Value. More...
int	get_value_integer (int &outValue)
	Get the User Defined Value. More...
int	get_value_node_connector (Dtk_NodeConnectorPtr &outValue)
	Get the User Defined Value - Node Connector to retrieve geometric entities using _ReadConnectedEntity. More...
int	get_value_role (Dtk_string &outRole)
	Get the User Defined Value role, defined as the title of the value. More...
int	get_value_string (Dtk_string &outValue)
	Get the User Defined Value. More...
int	get_value_type (DTK_USER_DEFINED_VAL_TYPE &outType)
	Get the User Defined Value type (Double, Length, Angle, Int, GeomID, NoValue, etc.) More...
	~Dtk_feat_user_defined_value ()

Data Fields
double	doubleValue
Dtk_NodeConnectorPtr	geomConnector
int	integerValue
Dtk_string	role
Dtk_string	stringValue
DTK_USER_DEFINED_VAL_TYPE	type

Constructor & Destructor Documentation

Dtk_feat_user_defined_value() [1/2]

Dtk_feat_user_defined_value::Dtk_feat_user_defined_value

(

)

     {
          this->type = DTK_USER_DEFINED_NOVALUE;
          this->integerValue = -1;
          this->doubleValue = 0.0;
          this->geomConnector = NULL; 
     }

~Dtk_feat_user_defined_value()

Dtk_feat_user_defined_value::~Dtk_feat_user_defined_value

(

)

Dtk_feat_user_defined_value() [2/2]

Dtk_feat_user_defined_value::Dtk_feat_user_defined_value

(

const Dtk_feat_user_defined_value &

inValue

)

     {
          this->role = inValue.role;
          this->type = inValue.type;
          this->integerValue = inValue.integerValue;
          this->doubleValue = inValue.doubleValue;
          this->stringValue = inValue.stringValue;
          this->geomConnector = inValue.geomConnector;      
     }

Member Function Documentation

get_value_double()

int Dtk_feat_user_defined_value::get_value_double

(

double &

outValue

)

Get the User Defined Value.

Parameters

[out]

User

Defined Value as double (for Double, Angle, Length)

Returns

NOTOK if error, ISOK if ok

Remarks

get_value_integer()

int Dtk_feat_user_defined_value::get_value_integer

(

int &

outValue

)

Get the User Defined Value.

Parameters

[out]

User

Defined Value as Integer (for Integer and GeomID)

Returns

NOTOK if error, ISOK if ok

Remarks

get_value_node_connector()

int Dtk_feat_user_defined_value::get_value_node_connector

(

Dtk_NodeConnectorPtr &

outValue

)

Get the User Defined Value - Node Connector to retrieve geometric entities using _ReadConnectedEntity.

This method is available only for Dtk_Component/Dtk_Node based approach

Parameters

[out]

User

Defined Type as ID GEOM

Returns

NOTOK if error, ISOK if ok

Remarks

get_value_role()

int Dtk_feat_user_defined_value::get_value_role

(

Dtk_string &

outRole

)

Get the User Defined Value role, defined as the title of the value.

Parameters

[out]

User

Defined role as Dtk_string

Returns

NOTOK if error, ISOK if ok

Remarks

get_value_string()

int Dtk_feat_user_defined_value::get_value_string

(

Dtk_string &

outValue

)

Get the User Defined Value.

Parameters

[out]

User

Defined Type as String

Returns

NOTOK if error, ISOK if ok

Remarks

get_value_type()

int Dtk_feat_user_defined_value::get_value_type

(

DTK_USER_DEFINED_VAL_TYPE &

outType

)

Get the User Defined Value type (Double, Length, Angle, Int, GeomID, NoValue, etc.)

Parameters

[out]

User

Defined Type as DTK_USER_DEFINED_VAL_TYPE

Returns

NOTOK if error, ISOK if ok

Remarks

Field Documentation

doubleValue

double Dtk_feat_user_defined_value::doubleValue

geomConnector

Dtk_NodeConnectorPtr Dtk_feat_user_defined_value::geomConnector

integerValue

int Dtk_feat_user_defined_value::integerValue

role

Dtk_string Dtk_feat_user_defined_value::role

stringValue

Dtk_string Dtk_feat_user_defined_value::stringValue

type

DTK_USER_DEFINED_VAL_TYPE Dtk_feat_user_defined_value::type