UN_Parm Class Reference

#include <UN_Parm.h>

Inheritance diagram for UN_Parm:

Public Member Functions
	UN_Parm (UN_GraphData *graph_data, UN_ParmID parm_id)
	Convenience constructor for the parameter handle. More...
UN_Node	node () const
	Returns the node this parameter belongs to. More...
UT_StringHolder	name () const
	Returns the name of the parameter. More...
UT_StringHolder	typeName () const
	Returns the name of the type of the parameter. More...
UT_OptionEntryPtr	value () const
	Returns the value of the parameter. More...
void	destroy () const
	Deletes this parameter. More...
UN_ParmID	parmID () const
	Returns the unique ID of the parm data this handle refers to. More...
	UN_Parm ()
	Default destructor, constructors and assignment operators. More...
	~UN_Parm ()
	Default destructor, constructors and assignment operators. More...
	UN_Parm (const UN_Parm &)
	Default destructor, constructors and assignment operators. More...
	UN_Parm (UN_Parm &&)
	Default destructor, constructors and assignment operators. More...
UN_Parm &	operator= (const UN_Parm &)
	Default destructor, constructors and assignment operators. More...
UN_Parm &	operator= (UN_Parm &&)
	Default destructor, constructors and assignment operators. More...
bool	isValid () const
	Returns true if the parameter exists; false otherwise. More...
	operator bool () const
	Returns true if the parameter exists; false otherwise. More...
bool	operator== (const UN_Parm &other) const
	Comparison operators. More...
bool	operator!= (const UN_Parm &other) const
	Comparison operators. More...
void	setValue (const UT_OptionEntry &opt) const
	Sets the parameter value. More...
void	setValue (UT_OptionEntryPtr &&opt) const
	Sets the parameter value. More...
Public Member Functions inherited from UN_Handle
	UN_Handle (UN_GraphData *graph_data, UN_DataID data_id)
	Convenience constructor. More...
	UN_Handle ()
	Default constructor. More...
UN_DataID	dataID () const
	~UN_Handle ()=default
	Default destructor, constructors and assignment operators. More...
	UN_Handle (const UN_Handle &)=default
	Default destructor, constructors and assignment operators. More...
	UN_Handle (UN_Handle &&)=default
	Default destructor, constructors and assignment operators. More...
UN_Handle &	operator= (const UN_Handle &)=default
	Default destructor, constructors and assignment operators. More...
UN_Handle &	operator= (UN_Handle &&)=default
	Default destructor, constructors and assignment operators. More...
bool	operator== (const UN_Handle &other) const
	Comparison operators. More...
bool	operator!= (const UN_Handle &other) const
	Comparison operators. More...

Protected Member Functions
UN_ParmData *	parmData () const
	The parm data container for all the ports in the graph. More...
Protected Member Functions inherited from UN_Handle
UN_GraphData *	graphData () const

Detailed Description

A light-weight handle for a node parameter data.

The actual parameter data (UN_ParmData) is owned and managed by UN_GraphData, and UN_Parm serves as a handle for clients to refer to that parm data.

Definition at line 31 of file UN_Parm.h.

Constructor & Destructor Documentation

UN_Parm::UN_Parm	(	UN_GraphData *	graph_data,
		UN_ParmID	parm_id
	)

Convenience constructor for the parameter handle.

UN_Parm::UN_Parm

(

)

Default destructor, constructors and assignment operators.

UN_Parm::~UN_Parm

(

)

Default destructor, constructors and assignment operators.

UN_Parm::UN_Parm

(

const UN_Parm &

)

Default destructor, constructors and assignment operators.

UN_Parm::UN_Parm

(

UN_Parm &&

)

Default destructor, constructors and assignment operators.

Member Function Documentation

void UN_Parm::destroy

(

)

const

Deletes this parameter.

bool UN_Parm::isValid

(

)

const

Returns true if the parameter exists; false otherwise.

UT_StringHolder UN_Parm::name

(

)

const

Returns the name of the parameter.

UN_Node UN_Parm::node

(

)

const

Returns the node this parameter belongs to.

UN_Parm::operator bool ( ) const

inlineexplicit

Returns true if the parameter exists; false otherwise.

Definition at line 48 of file UN_Parm.h.

bool UN_Parm::operator!= ( const UN_Parm &  other ) const

inline

Comparison operators.

Definition at line 55 of file UN_Parm.h.

UN_Parm& UN_Parm::operator=

(

const UN_Parm &

)

Default destructor, constructors and assignment operators.

UN_Parm& UN_Parm::operator=

(

UN_Parm &&

)

Default destructor, constructors and assignment operators.

bool UN_Parm::operator== ( const UN_Parm &  other ) const

inline

Comparison operators.

Definition at line 53 of file UN_Parm.h.

UN_ParmData* UN_Parm::parmData ( ) const

protected

The parm data container for all the ports in the graph.

UN_ParmID UN_Parm::parmID ( ) const

inline

Returns the unique ID of the parm data this handle refers to.

Definition at line 80 of file UN_Parm.h.

void UN_Parm::setValue

(

const UT_OptionEntry &

opt

)

const

Sets the parameter value.

void UN_Parm::setValue

(

UT_OptionEntryPtr &&

opt

)

const

Sets the parameter value.

UT_StringHolder UN_Parm::typeName

(

)

const

Returns the name of the type of the parameter.

UT_OptionEntryPtr UN_Parm::value

(

)

const

Returns the value of the parameter.

---

The documentation for this class was generated from the following file:

• UN/UN_Parm.h