UN_ConstParm Class Reference

#include <UN_Parm.h>

Inheritance diagram for UN_ConstParm:

Public Member Functions
	UN_ConstParm ()=default
	Constructs a handle for an invalid parameter. More...
	UN_ConstParm (const UN_GraphData *graph_data, UN_ParmID parm_id)
	Constructs a handle referencing the given parameter in the given graph. More...
	UN_ConstParm (const UN_Parm &parm)
	Constructs a const handle from a mutable parm handle. More...
UN_ConstGraph	graph () const
	Returns the graph whithin which this parameter exists. More...
UN_ConstNode	node () const
	Returns the node to which this parameter belongs. More...
bool	operator== (const UN_ConstParm &other) const
	Comparison operators. More...
bool	operator!= (const UN_ConstParm &other) const
	Comparison operators. More...
Public Member Functions inherited from UN_ParmBase< UN_ConstHandle, const 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...
const 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_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_ConstHandle, const 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 const parameter in a graph. It abstracts the APIs that operate on this parameter's data stored inside graph's data containers. It is a constant handle, so allows only queries of the parameter's data, but does not allow setting any new values on it.

Definition at line 146 of file UN_Parm.h.

Constructor & Destructor Documentation

UN_ConstParm::UN_ConstParm ( )

default

Constructs a handle for an invalid parameter.

UN_ConstParm::UN_ConstParm ( const UN_GraphData *  graph_data, UN_ParmID  parm_id  )

inline

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

Definition at line 154 of file UN_Parm.h.

UN_ConstParm::UN_ConstParm ( const UN_Parm &  parm )

inline

Constructs a const handle from a mutable parm handle.

Definition at line 159 of file UN_Parm.h.

Member Function Documentation

UN_ConstGraph UN_ConstParm::graph

(

)

const

Returns the graph whithin which this parameter exists.

UN_ConstNode UN_ConstParm::node

(

)

const

Returns the node to which this parameter belongs.

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

inline

Comparison operators.

Definition at line 168 of file UN_Parm.h.

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

inline

Comparison operators.

Definition at line 166 of file UN_Parm.h.

---

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

• UN/UN_Parm.h