UN_Handle Class Reference

#include <UN_Handle.h>

Inheritance diagram for UN_Handle:

Public Member Functions
	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_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 graph entity (eg, node, port, wire, etc). It abstracts the APIs that operate on this entity's data stored inside graph's data containers. It is a mutable handle, so allows setting the entity's data.

Definition at line 96 of file UN_Handle.h.

Constructor & Destructor Documentation

UN_Handle::UN_Handle ( )

inline

Constructs a reference handle for an invalid entity in the graph.

Definition at line 100 of file UN_Handle.h.

UN_Handle::UN_Handle ( UN_GraphData *  graph_data, UN_DataID  data_id  )

inline

Constructs reference handle to the data for a given entity in the graph.

Definition at line 105 of file UN_Handle.h.

Member Function Documentation

const UN_GraphData* UN_Handle::constGraphData ( ) const

inline

Returns the graph that owns, manages, and operates on the data object.

Definition at line 118 of file UN_Handle.h.

UN_GraphData* UN_Handle::graphData ( ) const

inline

Returns the graph that owns, manages, and operates on the data object.

Definition at line 110 of file UN_Handle.h.

---

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

• UN/UN_Handle.h