UN_GraphContext Class Reference

#include <UN_GraphContext.h>

Public Member Functions
bool	operator== (const UN_GraphContext &other) const
	Comparison operator. More...
const UT_StringHolder &	rootTypeName () const
	Returns the node type to be used for the root of this graph. More...
const UN_GraphConfig &	graphConfig () const
	Returns the configuration options for the graph in this context. More...
const UNI_Manager *	manager () const
	Returns the configuration options for the graph in this context. More...
	UN_GraphContext (UN_GraphConfig graph_config=UN_GraphConfig(), const UT_StringHolder &root_type_name=UT_StringHolder(), UNI_Manager *manager=nullptr)

Detailed Description

The graph context class, representing a specific use case for the graph. It provides specific values for the configurable behaviours of the graph, like alphanumeric validity and uniqueness of the nodes in the graph, and also supplies the graph with concrete node and data types to operate on.

Definition at line 28 of file UN_GraphContext.h.

Constructor & Destructor Documentation

UN_GraphContext::UN_GraphContext	(	UN_GraphConfig	graph_config = UN_GraphConfig(),
		const UT_StringHolder &	root_type_name = UT_StringHolder(),
		UNI_Manager *	manager = nullptr
	)

Constructor and destructor

Parameters

graph_config	Object that describes the graph's capabilities.
root_type_name	The node type name that should be used for the root node of this graph.
manager	Object that manages types. If given, it should outlive the context.

Member Function Documentation

const UN_GraphConfig& UN_GraphContext::graphConfig ( ) const

inline

Returns the configuration options for the graph in this context.

Definition at line 50 of file UN_GraphContext.h.

const UNI_Manager* UN_GraphContext::manager ( ) const

inline

Returns the configuration options for the graph in this context.

Definition at line 54 of file UN_GraphContext.h.

bool UN_GraphContext::operator==

(

const UN_GraphContext &

other

)

const

Comparison operator.

const UT_StringHolder& UN_GraphContext::rootTypeName ( ) const

inline

Returns the node type to be used for the root of this graph.

Definition at line 46 of file UN_GraphContext.h.

---

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

• UN/UN_GraphContext.h