UN_ParmBase< BASE_CLASS, GRAPH_DATA > Class Template Reference

#include <UN_Parm.h>

Inheritance diagram for UN_ParmBase< BASE_CLASS, GRAPH_DATA >:

Public Member Functions
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...
GRAPH_DATA *	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...

Protected Member Functions
	UN_ParmBase ()=default
	Constructs a handle for an invalid parameter. More...
template<typename GRAPH >
	UN_ParmBase (GRAPH *graph_data, UN_ParmID parm_id)
	Constructs a handle that references the given parm in the given graph. More...

Detailed Description

template<typename BASE_CLASS, typename GRAPH_DATA>
class UN_ParmBase< BASE_CLASS, GRAPH_DATA >

Base class template for the UN parameter handle. Its main purpose is to factor common code for const and non-const handles.

Definition at line 30 of file UN_Parm.h.

Constructor & Destructor Documentation

template<typename BASE_CLASS, typename GRAPH_DATA>

UN_ParmBase< BASE_CLASS, GRAPH_DATA >::UN_ParmBase ( )

protecteddefault

Constructs a handle for an invalid parameter.

template<typename BASE_CLASS, typename GRAPH_DATA>

template<typename GRAPH >

UN_ParmBase< BASE_CLASS, GRAPH_DATA >::UN_ParmBase ( GRAPH *  graph_data, UN_ParmID  parm_id  )

inlineprotected

Constructs a handle that references the given parm in the given graph.

Definition at line 39 of file UN_Parm.h.

Member Function Documentation

template<typename BASE_CLASS, typename GRAPH_DATA>

const UN_GraphData* UN_ParmBase< BASE_CLASS, GRAPH_DATA >::constGraphData ( ) const

inline

Returns the owner of the underlying graph data structures.

Definition at line 47 of file UN_Parm.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

GRAPH_DATA* UN_ParmBase< BASE_CLASS, GRAPH_DATA >::graphData ( ) const

inline

Returns the owner of the underlying graph data structures.

Definition at line 45 of file UN_Parm.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

bool UN_ParmBase< BASE_CLASS, GRAPH_DATA >::isValid ( ) const

inline

Returns true if this parm is valid within the graph; false otherwise.

Definition at line 56 of file UN_Parm.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_StringHolder& UN_ParmBase< BASE_CLASS, GRAPH_DATA >::name ( void  ) const

inline

Returns the parameter name that identifies it on the node.

Definition at line 68 of file UN_Parm.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

UN_ParmBase< BASE_CLASS, GRAPH_DATA >::operator bool ( ) const

inlineexplicit

Returns true if this parm is valid within the graph; false otherwise.

Definition at line 62 of file UN_Parm.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

UN_ParmID UN_ParmBase< BASE_CLASS, GRAPH_DATA >::parmID ( ) const

inline

Returns the unique ID of the parameter this handle refers to.

Definition at line 52 of file UN_Parm.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_StringHolder& UN_ParmBase< BASE_CLASS, GRAPH_DATA >::typeName ( ) const

inline

Returns the parameter's type that determines the value type.

Definition at line 74 of file UN_Parm.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

UT_OptionEntryPtr UN_ParmBase< BASE_CLASS, GRAPH_DATA >::value ( ) const

inline

Returns the value of the parameter.

Definition at line 80 of file UN_Parm.h.

---

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

• UN/UN_Parm.h