#include <UN_Parm.h>

Inheritance diagram for UN_Parm:

Public Member Functions
	UN_Parm ()=default
	Constructs a handle for an invalid node. More...

	UN_Parm (UN_GraphData *graph_data, UN_ParmID parm_id)
	Constructs a handle referencing the given parameter in the given graph. More...

UN_Graph	graph () const
	Returns the graph whithin which this port exists. More...

UN_Node	node () const
	Returns the node to which this parameter belongs. More...

void	setValue (const UT_OptionEntry &value) const
	Sets the parameter value. More...

void	setValue (UT_OptionEntryPtr &&value) const
	Sets the parameter value using move-assignment. More...

void	destroy () const
	Deletes this parameter and removes from the node and the graph. More...


bool	operator== (const UN_Parm &other) const
	Comparison operators. More...

bool	operator!= (const UN_Parm &other) const
	Comparison operators. More...

Public Member Functions inherited from UN_ParmBase< UN_Handle, UN_GraphData >
UN_ParmID	parmID () const
	Returns the unique ID of the parameter this handle refers to. More...

const UT_StringHolder &	name () const
	Returns the parameter name that identifies it on the node. More...

const UT_StringHolder &	typeName () const
	Returns the parameter's type that determines the value type. More...

UT_OptionEntryPtr	value () const
	Returns the value of the parameter. More...

UN_GraphData *	graphData () const
	Returns the owner of the underlying graph data structures. More...

const UN_GraphData *	constGraphData () const
	Returns the owner of the underlying graph data structures. More...

bool	isValid () const
	Returns true if this parm is valid within the graph; false otherwise. More...

	operator bool () const
	Returns true if this parm is valid within the graph; false otherwise. More...

Public Member Functions inherited from UN_Handle
	UN_Handle ()
	Constructs a reference handle for an invalid entity in the graph. More...

	UN_Handle (UN_GraphData *graph_data, UN_DataID data_id)
	Constructs reference handle to the data for a given entity in the graph. More...

UN_GraphData *	graphData () const
	Returns the graph that owns, manages, and operates on the data object. More...

const UN_GraphData *	constGraphData () const
	Returns the graph that owns, manages, and operates on the data object. More...

Public Member Functions inherited from UN_ConstHandle
	UN_ConstHandle ()
	Constructs a reference handle for an invalid entity in the graph. More...

	UN_ConstHandle (const UN_GraphData *graph_data, UN_DataID data_id)
	Constructs reference handle to the data for a given entity in the graph. More...

UN_DataID	dataID () const

const UN_GraphData *	graphData () const
	Returns the underlying graph data object. More...

const UN_GraphData *	constGraphData () const
	Returns the underlying graph data object. More...

Additional Inherited Members
Protected Member Functions inherited from UN_ParmBase< UN_Handle, UN_GraphData >
	UN_ParmBase ()=default
	Constructs a handle for an invalid parameter. More...

	UN_ParmBase (GRAPH *graph_data, UN_ParmID parm_id)
	Constructs a handle that references the given parm in the given graph. More...

Protected Member Functions inherited from UN_ConstHandle
bool	isNumericallyValid () const

bool	operator== (const UN_ConstHandle &other) const

bool	operator!= (const UN_ConstHandle &other) const

Detailed Description

A handle that references a mutable parameter in a graph. It abstracts the APIs that operate on this parameter's data, which is stored inside graph's data containers. It is a non-const (read-write) handle, so allows both queries and mutations (edits) of the parameter's data.

Definition at line 93 of file UN_Parm.h.

Constructor & Destructor Documentation

UN_Parm::UN_Parm ( )

default

Constructs a handle for an invalid node.

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

inline

Constructs a handle referencing the given parameter in the given graph.

Definition at line 100 of file UN_Parm.h.

Member Function Documentation

void UN_Parm::destroy ( ) const

inline

Deletes this parameter and removes from the node and the graph.

Definition at line 134 of file UN_Parm.h.

UN_Graph UN_Parm::graph ( ) const

Returns the graph whithin which this port exists.

UN_Node UN_Parm::node ( ) const

Returns the node to which this parameter belongs.

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

inline

Comparison operators.

Definition at line 109 of file UN_Parm.h.

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

inline

Comparison operators.

Definition at line 107 of file UN_Parm.h.

void UN_Parm::setValue ( const UT_OptionEntry & value ) const

inline

Sets the parameter value.

Definition at line 122 of file UN_Parm.h.

void UN_Parm::setValue ( UT_OptionEntryPtr && value ) const

inline

Sets the parameter value using move-assignment.

Definition at line 128 of file UN_Parm.h.

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

UN/UN_Parm.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation