UN_ConstWire Class Reference

#include <UN_Wire.h>

Inheritance diagram for UN_ConstWire:

Public Member Functions
	UN_ConstWire ()=default
	Constructs a handle for an invalid wire. More...
	UN_ConstWire (const UN_GraphData *graph_data, UN_WireID wire_id)
	Constructs a handle referencing the given wire in the given graph. More...
	UN_ConstWire (const UN_Wire &wire)
	Constructs a const handle from a mutable wire handle. More...
UN_ConstGraph	graph () const
	Returns the graph whithin which this wire exists. More...
bool	operator== (const UN_ConstWire &other) const
	Comparison operators. More...
bool	operator!= (const UN_ConstWire &other) const
	Comparison operators. More...
Public Member Functions inherited from UN_WireBase< UN_ConstHandle, const UN_GraphData, UN_ConstPort >
UN_WireID	wireID () const
	Returns the unique ID of the wire this handle refers to. More...
UN_ConstPort	srcPort () const
UN_ConstPort	dstPort () const
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_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_ConstHandle, const UN_GraphData, UN_ConstPort >
	UN_WireBase ()=default
	Constructs a handle for an invalid wire. More...
	UN_WireBase (const 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 const wire in a graph. It abstracts the APIs that operate on this wire's data stored inside graph's data containers. It is a constant handle, so allows only queries of the wire's data, and does not allow setting any new values for.

Definition at line 118 of file UN_Wire.h.

Constructor & Destructor Documentation

UN_ConstWire::UN_ConstWire ( )

default

Constructs a handle for an invalid wire.

UN_ConstWire::UN_ConstWire ( const UN_GraphData *  graph_data, UN_WireID  wire_id  )

inline

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

Definition at line 126 of file UN_Wire.h.

UN_ConstWire::UN_ConstWire ( const UN_Wire &  wire )

inline

Constructs a const handle from a mutable wire handle.

Definition at line 131 of file UN_Wire.h.

Member Function Documentation

UN_ConstGraph UN_ConstWire::graph

(

)

const

Returns the graph whithin which this wire exists.

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

inline

Comparison operators.

Definition at line 140 of file UN_Wire.h.

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

inline

Comparison operators.

Definition at line 138 of file UN_Wire.h.

---

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

• UN/UN_Wire.h