UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT > Class Template Reference

#include <UN_Wire.h>

Inheritance diagram for UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >:

Public Member Functions
UN_WireID	wireID () const
	Returns the unique ID of the wire this handle refers to. More...
PORT	srcPort () const
PORT	dstPort () const
GRAPH_DATA *	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...

Protected Member Functions
	UN_WireBase ()=default
	Constructs a handle for an invalid wire. More...
	UN_WireBase (GRAPH_DATA *graph_data, UN_WireID wire_id)
	Constructs a handle that references the given wire in the given graph. More...

Detailed Description

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>
class UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >

Base class template for the UN wire handle. Its main purpose is to factor common code for const and non-const handles.

Definition at line 30 of file UN_Wire.h.

Constructor & Destructor Documentation

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::UN_WireBase ( )

protecteddefault

Constructs a handle for an invalid wire.

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::UN_WireBase ( GRAPH_DATA *  graph_data, UN_WireID  wire_id  )

inlineprotected

Constructs a handle that references the given wire in the given graph.

Definition at line 37 of file UN_Wire.h.

Member Function Documentation

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

const UN_GraphData* UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::constGraphData ( ) const

inline

Returns the owner of the underlying graph data structures.

Definition at line 45 of file UN_Wire.h.

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

PORT UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::dstPort ( ) const

inline

Returns the destination port of this wire. Ie, port that receives and consumes the data.

Definition at line 73 of file UN_Wire.h.

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

GRAPH_DATA* UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::graphData ( ) const

inline

Returns the owner of the underlying graph data structures.

Definition at line 43 of file UN_Wire.h.

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

bool UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::isValid ( ) const

inline

Returns true if this wire is valid within the graph; false otherwise.

Definition at line 54 of file UN_Wire.h.

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::operator bool ( ) const

inlineexplicit

Returns true if this wire is valid within the graph; false otherwise.

Definition at line 59 of file UN_Wire.h.

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

PORT UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::srcPort ( ) const

inline

Returns the source port of this wire. Ie, port that produces and sends the data.

Definition at line 65 of file UN_Wire.h.

template<typename BASE_CLASS, typename GRAPH_DATA, typename PORT>

UN_WireID UN_WireBase< BASE_CLASS, GRAPH_DATA, PORT >::wireID ( ) const

inline

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

Definition at line 50 of file UN_Wire.h.

---

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

• UN/UN_Wire.h