#include <UN_Graph.h>

Inheritance diagram for UN_Graph:

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

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

UN_Node	createNode (const UT_StringRef &node_name_or_path=UT_StringRef(), const UT_StringRef &node_type=UT_StringRef(), const UT_StringRef &node_category=UT_StringRef()) const
	Creates a node in the graph. More...

void	deleteNode (const UT_StringRef &node_name_or_path) const
	Removes and deletes the node from this graph. More...

UN_StickyNote	createStickyNote (const UT_StringRef &sticky_note_name_or_path=UT_StringRef(), const UT_StringRef &sticky_note_text=UT_StringRef()) const
	Creates a sticky note in the graph. More...

void	deleteStickyNote (const UT_StringRef &sticky_note_name_or_path) const
	Removes and deletes the sticky note from this graph. More...

void	setFromOptions (const UN_Options &graph_opts) const
	Load and set the graph based on the given options. More...


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

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

Public Member Functions inherited from UN_GraphBase< UN_GraphData, UN_Node, UN_Wire, UN_StickyNote >
UN_Node	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_Node	findNode (const UT_StringRef &node_path) const

UN_StickyNote	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_Node >	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_Wire >	topWires () const
	Returns the wires connecting top level nodes directly inside this graph. More...

AllWireRange	allWireRange () const

UN_OptionsPtr	asOptions () 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< UN_GraphData, UN_Node, UN_Wire, UN_StickyNote >
using	TopNodeIterator = typename UN_Node::ChildNodeIterator
	Iterarates over the top-level nodes of the graph. More...

using	TopNodeRange = UT_IteratorRange< TopNodeIterator >

using	AllNodeIterator = typename UN_Node::DescendantNodeIterator

using	AllNodeRange = UT_IteratorRange< AllNodeIterator >

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

using	TopWireRange = UT_IteratorRange< TopWireIterator >

using	AllWireIterator = typename UN_Node::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< UN_GraphData, UN_Node, UN_Wire, UN_StickyNote >
	UN_GraphBase ()=default
	Constructs a handle for an invalid wire. More...

	UN_GraphBase (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 non-const (mutable) graph. It abstracts the APIs that operate on this graph's data, which is stored inside graph's data container. It is a non-const (read-write) handle, so allows both queries and mutations of the graph's data.

Definition at line 194 of file UN_Graph.h.

Constructor & Destructor Documentation

UN_Graph::UN_Graph ( )

default

Constructs a handle for an invalid graph.

UN_Graph::UN_Graph ( UN_GraphData * graph_data )

inline

Constructor that creates handle for the given graph data.

Definition at line 202 of file UN_Graph.h.

Member Function Documentation

UN_Node UN_Graph::createNode	(	const UT_StringRef &	node_name_or_path = `UT_StringRef()`,
		const UT_StringRef &	node_type = `UT_StringRef()`,
		const UT_StringRef &	node_category = `UT_StringRef()`
	)		const

inline

Creates a node in the graph.

Definition at line 217 of file UN_Graph.h.

UN_StickyNote UN_Graph::createStickyNote	(	const UT_StringRef &	sticky_note_name_or_path = `UT_StringRef()`,
		const UT_StringRef &	sticky_note_text = `UT_StringRef()`
	)		const

inline

Creates a sticky note in the graph.

Definition at line 235 of file UN_Graph.h.

void UN_Graph::deleteNode ( const UT_StringRef & node_name_or_path ) const

inline

Removes and deletes the node from this graph.

Definition at line 228 of file UN_Graph.h.

void UN_Graph::deleteStickyNote ( const UT_StringRef & sticky_note_name_or_path ) const

inline

Removes and deletes the sticky note from this graph.

Definition at line 245 of file UN_Graph.h.

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

inline

Comparison operators.

Definition at line 211 of file UN_Graph.h.

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

inline

Comparison operators.

Definition at line 209 of file UN_Graph.h.

void UN_Graph::setFromOptions ( const UN_Options & graph_opts ) const

inline

Load and set the graph based on the given options.

Definition at line 251 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