UNI_GraphHandle Class Reference

#include <UNI_GraphHandle.h>

Inheritance diagram for UNI_GraphHandle:

Public Member Functions
	UNI_GraphHandle ()=default
	Constructor for the graph handle. More...
	UNI_GraphHandle (UNI_GraphID graph_id)
	Constructor for the graph handle. More...
	UNI_GraphHandle (const UNI_GraphPtr &graph_ptr)
	Constructor for the graph handle. More...
	UNI_GraphHandle (UNI_GraphPtr &&graph_ptr)
	Constructor for the graph handle. More...
	UNI_GraphHandle (UT_UniquePtr< UNI_Graph > graph)
UNI_Graph *	graph () const
	Returns the UNI graph referenced by this handle. More...
UNI_Graph *	operator-> () const
	Returns the UNI graph referenced by this handle. More...
Public Member Functions inherited from UNI_ConstGraphHandle
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_Graph *	graph () const
	Returns the UNI graph referenced by this handle. More...
const UNI_Graph *	operator-> () const
	Returns the UNI graph referenced by this handle. More...

Detailed Description

Definition at line 65 of file UNI_GraphHandle.h.

Constructor & Destructor Documentation

UNI_GraphHandle::UNI_GraphHandle ( )

default

Constructor for the graph handle.

UNI_GraphHandle::UNI_GraphHandle ( UNI_GraphID  graph_id )

explicit

Constructor for the graph handle.

UNI_GraphHandle::UNI_GraphHandle ( const UNI_GraphPtr &  graph_ptr )

inline

Constructor for the graph handle.

Definition at line 71 of file UNI_GraphHandle.h.

UNI_GraphHandle::UNI_GraphHandle ( UNI_GraphPtr &&  graph_ptr )

inline

Constructor for the graph handle.

Definition at line 73 of file UNI_GraphHandle.h.

UNI_GraphHandle::UNI_GraphHandle ( UT_UniquePtr< UNI_Graph >  graph )

inlineexplicit

Takes ownership of a freshly created graph. The graph has already registered itself in the look-up table in its constructor; this handle's reference count becomes the sole owner of the graph.

Definition at line 78 of file UNI_GraphHandle.h.

Member Function Documentation

UNI_Graph* UNI_GraphHandle::graph ( ) const

inline

Returns the UNI graph referenced by this handle.

Definition at line 83 of file UNI_GraphHandle.h.

UNI_Graph* UNI_GraphHandle::operator-> ( ) const

inline

Returns the UNI graph referenced by this handle.

Definition at line 90 of file UNI_GraphHandle.h.

---

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

• UNI/UNI_GraphHandle.h