#include <UN_Graph.h>

Inheritance diagram for UN_ConstGraph:

Public Member Functions
	UN_ConstGraph ()=default
	Constructs a handle for an invalid graph. More...

	UN_ConstGraph (const UN_GraphData *graph_data)
	Constructor that creates handle for the given graph data. More...

	UN_ConstGraph (const UN_Graph &graph)
	Constructs a const handle from a mutable graph handle. More...


bool	operator== (const UN_ConstGraph &other) const
	Comparison operators. More...

bool	operator!= (const UN_ConstGraph &other) const
	Comparison operators. More...

Public Member Functions inherited from UN_GraphBase< const UN_GraphData, UN_ConstNode, UN_ConstWire, UN_ConstStickyNote >
UN_ConstNode	rootNode () const

bool	isValidNodeName (const UT_StringRef &name) const

UT_StringHolder	findValidUniqueNodeName (const UT_StringRef &name=UT_StringRef()) const

UT_Array< UT_StringHolder >	nodeNames () const
	Returns the names of the graph's top-level nodes. More...

UN_ConstNode	findNode (const UT_StringRef &node_path) const

UN_ConstStickyNote	findStickyNote (const UT_StringRef &sticky_note_path) const

TopNodeRange	topNodeRange () const
	Returns a range for iterating over graph's top-level nodes. More...

UT_Array< UN_ConstNode >	topNodes () const
	Returns the top level nodes directly inside this graph. More...

AllNodeRange	allNodeRange () const

TopWireRange	topWireRange () const
	Returns a range for iterating over graph's top-level connection wires. More...

UT_Array< UN_ConstWire >	topWires () const
	Returns the wires connecting top level nodes directly inside this graph. More...

AllWireRange	allWireRange () const

UN_OptionsPtr	asOptions () const

const UN_GraphData *	graphData () const
	Returns the owner container of the underlying graph data structures. More...

const UN_GraphData *	constGraphData () const
	Returns the owner container of the underlying graph data structures. More...

bool	isValid () const
	Returns true if this is a valid graph; false otherwise. More...

	operator bool () const
	Returns true if this is a valid graph; false otherwise. More...

Additional Inherited Members
Public Types inherited from UN_GraphBase< const UN_GraphData, UN_ConstNode, UN_ConstWire, UN_ConstStickyNote >
using	TopNodeIterator = typename UN_ConstNode::ChildNodeIterator
	Iterarates over the top-level nodes of the graph. More...

using	TopNodeRange = UT_IteratorRange< TopNodeIterator >

using	AllNodeIterator = typename UN_ConstNode::DescendantNodeIterator

using	AllNodeRange = UT_IteratorRange< AllNodeIterator >

using	TopWireIterator = typename UN_ConstNode::ChildWireIterator
	An iterator and a range for the top-level wires inside this graph. More...

using	TopWireRange = UT_IteratorRange< TopWireIterator >

using	AllWireIterator = typename UN_ConstNode::DescendantWireIterator
	An iterator and a range for all the connection wires in this graph. More...

using	AllWireRange = UT_IteratorRange< AllWireIterator >

Protected Member Functions inherited from UN_GraphBase< const UN_GraphData, UN_ConstNode, UN_ConstWire, UN_ConstStickyNote >
	UN_GraphBase ()=default
	Constructs a handle for an invalid wire. More...

	UN_GraphBase (const UN_GraphData *graph_data)
	Constructs a handle that references the given wire in the given graph. More...

bool	operator== (const UN_GraphBase &other) const
	Comparison operators. More...

bool	operator!= (const UN_GraphBase &other) const
	Comparison operators. More...

Detailed Description

A handle that references a const graph. It abstracts the APIs that operate on this graph's data. It is a constant handle, so allows only queries of the graph's data, and does not allow modifying it.

Definition at line 263 of file UN_Graph.h.

Constructor & Destructor Documentation

UN_ConstGraph::UN_ConstGraph ( )

default

Constructs a handle for an invalid graph.

UN_ConstGraph::UN_ConstGraph ( const UN_GraphData * graph_data )

inline

Constructor that creates handle for the given graph data.

Definition at line 271 of file UN_Graph.h.

UN_ConstGraph::UN_ConstGraph ( const UN_Graph & graph )

inline

Constructs a const handle from a mutable graph handle.

Definition at line 276 of file UN_Graph.h.

Member Function Documentation

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

inline

Comparison operators.

Definition at line 285 of file UN_Graph.h.

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

inline

Comparison operators.

Definition at line 283 of file UN_Graph.h.

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

UN/UN_Graph.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation