UN_ConstHandle Class Reference

#include <UN_Handle.h>

Inheritance diagram for UN_ConstHandle:

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

Protected Member Functions
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 constant handle, so allows only queries of the entity's data, but does not allow setting new values for.

Definition at line 27 of file UN_Handle.h.

Constructor & Destructor Documentation

UN_ConstHandle::UN_ConstHandle ( )

inline

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

Definition at line 31 of file UN_Handle.h.

UN_ConstHandle::UN_ConstHandle ( const 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 38 of file UN_Handle.h.

Member Function Documentation

const UN_GraphData* UN_ConstHandle::constGraphData ( ) const

inline

Returns the underlying graph data object.

Definition at line 46 of file UN_Handle.h.

UN_DataID UN_ConstHandle::dataID ( ) const

inline

The unique number identifying this data object during the lifespan of the owner graph. Used for referring to this object in the graph.

Definition at line 52 of file UN_Handle.h.

const UN_GraphData* UN_ConstHandle::graphData ( ) const

inline

Returns the underlying graph data object.

Definition at line 44 of file UN_Handle.h.

bool UN_ConstHandle::isNumericallyValid ( ) const

inlineprotected

Returns true if the handle can refer to a valid data. Note, subclasses have a stricter notion of a valid handle: not only it needs to be numerically valid, but

Definition at line 78 of file UN_Handle.h.

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

inlineprotected

Comparison operators, for use by the derived classes. Note, protected to prevent comparing against incompatible handles, for example, UN_Port against UN_Wire.

Definition at line 68 of file UN_Handle.h.

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

inlineprotected

Comparison operators, for use by the derived classes. Note, protected to prevent comparing against incompatible handles, for example, UN_Port against UN_Wire.

Definition at line 59 of file UN_Handle.h.

---

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

• UN/UN_Handle.h