HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UNI_ConstItem< UNI_ID_TYPE > Class Template Reference

#include <UNI_Item.h>

Public Member Functions

 UNI_ConstItem ()=default
 Constructor. More...
 
 UNI_ConstItem (const UNI_ConstGraphHandle &graph_handle, UNI_ID_TYPE id)
 
 UNI_ConstItem (UNI_ConstGraphHandle &&graph_handle, UNI_ID_TYPE id)
 Constructor with r-value for the intrusive graph pointer. More...
 
const UNI_Graphgraph () const
 Returns the graph inside which the node lives. More...
 
UNI_ID_TYPE id () const
 Returns the ID of the node in the graph. More...
 
bool isValid () const
 
 operator bool () const
 

Protected Member Functions

const UNI_ConstGraphHandlegraphHandle () const
 Returns the underlying graph handle. More...
 

Detailed Description

template<class UNI_ID_TYPE>
class UNI_ConstItem< UNI_ID_TYPE >

Definition at line 20 of file UNI_Item.h.

Constructor & Destructor Documentation

template<class UNI_ID_TYPE>
UNI_ConstItem< UNI_ID_TYPE >::UNI_ConstItem ( )
default

Constructor.

template<class UNI_ID_TYPE>
UNI_ConstItem< UNI_ID_TYPE >::UNI_ConstItem ( const UNI_ConstGraphHandle graph_handle,
UNI_ID_TYPE  id 
)
inline

Definition at line 25 of file UNI_Item.h.

template<class UNI_ID_TYPE>
UNI_ConstItem< UNI_ID_TYPE >::UNI_ConstItem ( UNI_ConstGraphHandle &&  graph_handle,
UNI_ID_TYPE  id 
)
inline

Constructor with r-value for the intrusive graph pointer.

Definition at line 31 of file UNI_Item.h.

Member Function Documentation

template<class UNI_ID_TYPE>
const UNI_Graph* UNI_ConstItem< UNI_ID_TYPE >::graph ( ) const
inline

Returns the graph inside which the node lives.

Definition at line 44 of file UNI_Item.h.

template<class UNI_ID_TYPE>
const UNI_ConstGraphHandle& UNI_ConstItem< UNI_ID_TYPE >::graphHandle ( ) const
inlineprotected

Returns the underlying graph handle.

Definition at line 51 of file UNI_Item.h.

template<class UNI_ID_TYPE>
UNI_ID_TYPE UNI_ConstItem< UNI_ID_TYPE >::id ( ) const
inline

Returns the ID of the node in the graph.

Definition at line 47 of file UNI_Item.h.

template<class UNI_ID_TYPE>
bool UNI_ConstItem< UNI_ID_TYPE >::isValid ( ) const
inline

Returns true if the UNI node is valid. Ie, it has a valid API with a valid graph, and represents a valid node in that graph.

Definition at line 38 of file UNI_Item.h.

template<class UNI_ID_TYPE>
UNI_ConstItem< UNI_ID_TYPE >::operator bool ( ) const
inlineexplicit

Returns true if the UNI node is valid. Ie, it has a valid API with a valid graph, and represents a valid node in that graph.

Definition at line 40 of file UNI_Item.h.


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