UN_Wire Class Reference

#include <UN_Wire.h>

Inheritance diagram for UN_Wire:

Public Member Functions
	UN_Wire (UN_GraphData *graph_data, UN_WireIndex wire_index, UN_WireID wire_id)
	Convenience constructor for the wire handle. More...
UN_Graph	graph () const
	Returns the owner graph of this wire. More...
UN_Port	sourcePort () const
UN_Port	destinationPort () const
UN_WireIndex	wireIndex () const
	Returns the wire data index this handle refers to. More...
UN_WireID	wireID () const
	Returns the unique ID of the wire data this handle refers to. More...
	UN_Wire ()
	Default constructors and assignment operators. More...
	~UN_Wire ()
	Default constructors and assignment operators. More...
	UN_Wire (const UN_Wire &other)
	Default constructors and assignment operators. More...
	UN_Wire (UN_Wire &&other)
	Default constructors and assignment operators. More...
UN_Wire &	operator= (const UN_Wire &other)
	Default constructors and assignment operators. More...
UN_Wire &	operator= (UN_Wire &&other)
	Default constructors and assignment operators. More...
bool	isValid () const
	Returns true if this is a valid wire; false otherwise. More...
	operator bool () const
	Returns true if this is a valid wire; false otherwise. 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_Handle
	UN_Handle (UN_GraphData *graph_data, UN_DataIndex data_index, UN_DataID data_id)
	Convenience constructor. More...
	UN_Handle ()
	Default constructor. More...
UN_DataIndex	dataIndex () const
UN_DataID	dataID () const
	The unique ID of a data object during the lifespan of the owner graph. More...
	~UN_Handle ()=default
	Default destructor, constructors and assignment operators. More...
	UN_Handle (const UN_Handle &)=default
	Default destructor, constructors and assignment operators. More...
	UN_Handle (UN_Handle &&)=default
	Default destructor, constructors and assignment operators. More...
UN_Handle &	operator= (const UN_Handle &)=default
	Default destructor, constructors and assignment operators. More...
UN_Handle &	operator= (UN_Handle &&)=default
	Default destructor, constructors and assignment operators. More...
bool	operator== (const UN_Handle &other) const
	Comparison operators. More...
bool	operator!= (const UN_Handle &other) const
	Comparison operators. More...

Additional Inherited Members
Protected Member Functions inherited from UN_Handle
UN_GraphData *	graphData () const

Detailed Description

A light-weight handle for a wire that connects two ports together.

The actual wire data (UN_WireData) is owned and managed by UN_GraphData, and UN_Wire serves as a handle for the client to refer to that data.

Definition at line 28 of file UN_Wire.h.

Constructor & Destructor Documentation

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

Convenience constructor for the wire handle.

UN_Wire::UN_Wire

(

)

Default constructors and assignment operators.

UN_Wire::~UN_Wire

(

)

Default constructors and assignment operators.

UN_Wire::UN_Wire

(

const UN_Wire &

other

)

Default constructors and assignment operators.

UN_Wire::UN_Wire

(

UN_Wire &&

other

)

Default constructors and assignment operators.

Member Function Documentation

UN_Port UN_Wire::destinationPort

(

)

const

Returns the destination port of this wire. (ie, port that receives and consumes the data).

UN_Graph UN_Wire::graph

(

)

const

Returns the owner graph of this wire.

bool UN_Wire::isValid

(

)

const

Returns true if this is a valid wire; false otherwise.

UN_Wire::operator bool ( ) const

inlineexplicit

Returns true if this is a valid wire; false otherwise.

Definition at line 47 of file UN_Wire.h.

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

inline

Comparison operators.

Definition at line 54 of file UN_Wire.h.

UN_Wire& UN_Wire::operator=

(

const UN_Wire &

other

)

Default constructors and assignment operators.

UN_Wire& UN_Wire::operator=

(

UN_Wire &&

other

)

Default constructors and assignment operators.

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

inline

Comparison operators.

Definition at line 52 of file UN_Wire.h.

UN_Port UN_Wire::sourcePort

(

)

const

Returns the source port of this wire. (ie, port that produces and sends the data).

UN_WireID UN_Wire::wireID ( ) const

inline

Returns the unique ID of the wire data this handle refers to.

Definition at line 76 of file UN_Wire.h.

UN_WireIndex UN_Wire::wireIndex ( ) const

inline

Returns the wire data index this handle refers to.

Definition at line 72 of file UN_Wire.h.

---

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

• UN/UN_Wire.h