HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UNI_ConstGraphHandle Class Reference

#include <UNI_GraphHandle.h>

+ Inheritance diagram for UNI_ConstGraphHandle:

Public Member Functions

UNI_GraphID graphID () const
 Returns the ID of a UNI graph referenced by this handle. More...
 
 UNI_ConstGraphHandle ()=default
 Constructor for the graph handle. More...
 
 UNI_ConstGraphHandle (UNI_GraphID graph_id)
 Constructor for the graph handle. More...
 
 UNI_ConstGraphHandle (const UNI_ConstGraphPtr &graph_ptr)
 Constructor for the graph handle. More...
 
 UNI_ConstGraphHandle (UNI_ConstGraphPtr &&graph_ptr)
 Constructor for the graph handle. More...
 
bool isValid () const
 Returns true if this handle refers to a valid graph; false otherwise. More...
 
 operator bool () const
 Returns true if this handle refers to a valid graph; false otherwise. More...
 
bool operator== (const UNI_ConstGraphHandle &other) const
 Comparison operators. More...
 
bool operator!= (const UNI_ConstGraphHandle &other) const
 Comparison operators. More...
 
const UNI_Graphgraph () const
 Returns the UNI graph referenced by this handle. More...
 
const UNI_Graphoperator-> () const
 Returns the UNI graph referenced by this handle. More...
 

Detailed Description

Definition at line 20 of file UNI_GraphHandle.h.

Constructor & Destructor Documentation

UNI_ConstGraphHandle::UNI_ConstGraphHandle ( )
default

Constructor for the graph handle.

UNI_ConstGraphHandle::UNI_ConstGraphHandle ( UNI_GraphID  graph_id)
explicit

Constructor for the graph handle.

UNI_ConstGraphHandle::UNI_ConstGraphHandle ( const UNI_ConstGraphPtr graph_ptr)
inline

Constructor for the graph handle.

Definition at line 26 of file UNI_GraphHandle.h.

UNI_ConstGraphHandle::UNI_ConstGraphHandle ( UNI_ConstGraphPtr &&  graph_ptr)
inline

Constructor for the graph handle.

Definition at line 28 of file UNI_GraphHandle.h.

Member Function Documentation

const UNI_Graph* UNI_ConstGraphHandle::graph ( ) const
inline

Returns the UNI graph referenced by this handle.

Definition at line 47 of file UNI_GraphHandle.h.

UNI_GraphID UNI_ConstGraphHandle::graphID ( ) const
inline

Returns the ID of a UNI graph referenced by this handle.

Definition at line 54 of file UNI_GraphHandle.h.

bool UNI_ConstGraphHandle::isValid ( ) const
inline

Returns true if this handle refers to a valid graph; false otherwise.

Definition at line 33 of file UNI_GraphHandle.h.

UNI_ConstGraphHandle::operator bool ( ) const
inlineexplicit

Returns true if this handle refers to a valid graph; false otherwise.

Definition at line 35 of file UNI_GraphHandle.h.

bool UNI_ConstGraphHandle::operator!= ( const UNI_ConstGraphHandle other) const
inline

Comparison operators.

Definition at line 42 of file UNI_GraphHandle.h.

const UNI_Graph* UNI_ConstGraphHandle::operator-> ( ) const
inline

Returns the UNI graph referenced by this handle.

Definition at line 49 of file UNI_GraphHandle.h.

bool UNI_ConstGraphHandle::operator== ( const UNI_ConstGraphHandle other) const
inline

Comparison operators.

Definition at line 40 of file UNI_GraphHandle.h.


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