UN_Wire Class Reference

#include <UN_Wire.h>

Inheritance diagram for UN_Wire:

Public Member Functions
	UN_Wire ()=default
	Constructs a handle for an invalid wire. More...
	UN_Wire (UN_GraphData *graph_data, UN_WireID wire_id)
	Constructs a handle referencing the given wire in the given graph. More...
UN_Graph	graph () const
	Returns the graph whithin which this wire exists. More...
bool	operator== (const UN_Wire &other) const
	Comparison operators. More...
bool	operator!= (const UN_Wire &other) const
	Comparison operators. More...
Public Member Functions inherited from UN_WireBase< UN_Handle, UN_GraphData, UN_Port >
UN_WireID	wireID () const
	Returns the unique ID of the wire this handle refers to. More...
UN_Port	srcPort () const
UN_Port	dstPort () const
UN_GraphData *	graphData () const
	Returns the owner of the underlying graph data structures. More...
const UN_GraphData *	constGraphData () const
	Returns the owner of the underlying graph data structures. More...
bool	isValid () const
	Returns true if this wire is valid within the graph; false otherwise. More...
	operator bool () const
	Returns true if this wire is valid within the graph; false otherwise. More...
Public Member Functions inherited from UN_Handle
	UN_Handle ()
	Constructs a reference handle for an invalid entity in the graph. More...
	UN_Handle (UN_GraphData *graph_data, UN_DataID data_id)
	Constructs reference handle to the data for a given entity in the graph. More...
UN_GraphData *	graphData () const
	Returns the graph that owns, manages, and operates on the data object. More...
const UN_GraphData *	constGraphData () const
	Returns the graph that owns, manages, and operates on the data object. More...
Public Member Functions inherited from UN_ConstHandle
	UN_ConstHandle ()
	Constructs a reference handle for an invalid entity in the graph. More...
	UN_ConstHandle (const UN_GraphData *graph_data, UN_DataID data_id)
	Constructs reference handle to the data for a given entity in the graph. More...
UN_DataID	dataID () const
const UN_GraphData *	graphData () const
	Returns the underlying graph data object. More...
const UN_GraphData *	constGraphData () const
	Returns the underlying graph data object. More...

Additional Inherited Members
Protected Member Functions inherited from UN_WireBase< UN_Handle, UN_GraphData, UN_Port >
	UN_WireBase ()=default
	Constructs a handle for an invalid wire. More...
	UN_WireBase (UN_GraphData *graph_data, UN_WireID wire_id)
	Constructs a handle that references the given wire in the given graph. More...
Protected Member Functions inherited from UN_ConstHandle
bool	isNumericallyValid () const
bool	operator== (const UN_ConstHandle &other) const
bool	operator!= (const UN_ConstHandle &other) const

Detailed Description

A handle that references a mutable wire in a graph. It abstracts the APIs that operate on this wire's data stored inside graph's data containers. It is a non-const (read-write) handle, so allows both queries and mutations of the wire's data.

Definition at line 86 of file UN_Wire.h.

Constructor & Destructor Documentation

UN_Wire::UN_Wire ( )

default

Constructs a handle for an invalid wire.

UN_Wire::UN_Wire ( UN_GraphData *  graph_data, UN_WireID  wire_id  )

inline

Constructs a handle referencing the given wire in the given graph.

Definition at line 94 of file UN_Wire.h.

Member Function Documentation

UN_Graph UN_Wire::graph

(

)

const

Returns the graph whithin which this wire exists.

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

inline

Comparison operators.

Definition at line 103 of file UN_Wire.h.

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

inline

Comparison operators.

Definition at line 101 of file UN_Wire.h.

---

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

• UN/UN_Wire.h