UN_Handle Class Reference

#include <UN_Handle.h>

Inheritance diagram for UN_Handle:

Public Member Functions
	UN_Handle (UN_GraphData *graph_data, UN_DataIndex data_index, UN_DataID data_id)
	Convenience constructor. More...
	UN_Handle ()
	Default constructor. More...
UN_DataIndex	dataIndex () const
UN_DataID	dataID () const
	The unique ID of a data object during the lifespan of the owner graph. More...
	~UN_Handle ()=default
	Default destructor, constructors and assignment operators. More...
	UN_Handle (const UN_Handle &)=default
	Default destructor, constructors and assignment operators. More...
	UN_Handle (UN_Handle &&)=default
	Default destructor, constructors and assignment operators. More...
UN_Handle &	operator= (const UN_Handle &)=default
	Default destructor, constructors and assignment operators. More...
UN_Handle &	operator= (UN_Handle &&)=default
	Default destructor, constructors and assignment operators. More...
bool	operator== (const UN_Handle &other) const
	Comparison operators. More...
bool	operator!= (const UN_Handle &other) const
	Comparison operators. More...

Protected Member Functions
UN_GraphData *	graphData () const

Detailed Description

Data class that is basis for many data classes. It factors out the behavious of a data object inside a data container.

Definition at line 27 of file UN_Handle.h.

Constructor & Destructor Documentation

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

inline

Convenience constructor.

Definition at line 31 of file UN_Handle.h.

UN_Handle::UN_Handle ( )

inline

Default constructor.

Definition at line 40 of file UN_Handle.h.

UN_Handle::~UN_Handle ( )

default

Default destructor, constructors and assignment operators.

UN_Handle::UN_Handle ( const UN_Handle &  )

default

Default destructor, constructors and assignment operators.

UN_Handle::UN_Handle ( UN_Handle &&  )

default

Default destructor, constructors and assignment operators.

Member Function Documentation

UN_DataID UN_Handle::dataID ( ) const

inline

The unique ID of a data object during the lifespan of the owner graph.

Definition at line 74 of file UN_Handle.h.

UN_DataIndex UN_Handle::dataIndex ( ) const

inline

Index identifying the data object within the owner graph. Note, a data object may reuse space from previously deleted data object, and thus share the same data index into the data container.

Definition at line 70 of file UN_Handle.h.

UN_GraphData* UN_Handle::graphData ( ) const

inlineprotected

The graph data struct that owns, manages, and operates on data object. Returning a non-const pointer from const method, since the derived classes have const methods that operate on non-const graph.

Definition at line 81 of file UN_Handle.h.

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

inline

Comparison operators.

Definition at line 60 of file UN_Handle.h.

UN_Handle& UN_Handle::operator= ( const UN_Handle &  )

default

Default destructor, constructors and assignment operators.

UN_Handle& UN_Handle::operator= ( UN_Handle &&  )

default

Default destructor, constructors and assignment operators.

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

inline

Comparison operators.

Definition at line 53 of file UN_Handle.h.

---

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

• UN/UN_Handle.h