engine::WiringSituation Class Reference

#include <nodewiring-def.hpp>

List of all members.

---

Detailed Description

Finding out about a concrete way of wiring up a ProcNode about to be built.

Such a (temporary) setup object is used while building the low-level model. It is loaded with information concerning the intended connections to be made and then used to initialise the wiring descriptor, which in turn allows us to setup the ProcNode.

intended usage pattern

The goal is to describe the constellation of a new node to be built. Thus, we start with one or several existing nodes, specifying which output should go to which input pin of the yet-to-be created new node. When intending to create a source node, a default WiringSituation should be used, without adding any connection information.

Definition at line 73 of file nodewiring-def.hpp.

Public Member Functions
lumiera::NodeID const &	createNodeID () const
WiringSituation &	defineInput (uint inPin, PNode pred)
	set up the next input connection to a specific input pin, originating at a the next/sole output pin of the predecessor
WiringSituation &	defineInput (PNode pred, uint outPin)
	set up the next input connection, originating at a specific output pin of the predecessor
WiringSituation &	defineInput (uint inPin, PNode pred, uint outPin)
	set up a connection leading to a specific input pin of the new node
long	getFlags () const
RefArray< InChanDescriptor > &	makeInDescriptor () const
RefArray< ChannelDescriptor > &	makeOutDescriptor () const
WiringDescriptor::ProcFunc *	resolveProcessingFunction () const
WiringSituation &	resolveProcessor (asset::Proc const &procAsset)
	trigger resolving of the actual processing function
WiringSituation &	setFlag (long code)
	set detail flags regarding the desired node operation mode
	WiringSituation (PNode predecessor)
	Continue the wiring by hooking directly into the output of an existing predecessor node.
	WiringSituation ()
	A default WiringSituation doesn't specify any connections.
Private Attributes
long	flags_
asset::Proc::ProcFunc *	function_

---

Constructor & Destructor Documentation

engine::WiringSituation::WiringSituation

(

)

[inline]

A default WiringSituation doesn't specify any connections.

It can be used as-is for building a source node, or augmented with connection informations later on.

Definition at line 113 of file nodewiring-def.hpp.

engine::WiringSituation::WiringSituation

(

PNode

predecessor

)

[inline]

Continue the wiring by hooking directly into the output of an existing predecessor node.

Definition at line 124 of file nodewiring-def.hpp.

---

Member Function Documentation

WiringSituation& engine::WiringSituation::defineInput	(	uint	inPin,
		PNode	pred
	)			[inline]

set up the next input connection to a specific input pin, originating at a the next/sole output pin of the predecessor

Definition at line 157 of file nodewiring-def.hpp.

WiringSituation& engine::WiringSituation::defineInput	(	PNode	pred,
		uint	outPin
	)			[inline]

set up the next input connection, originating at a specific output pin of the predecessor

Definition at line 148 of file nodewiring-def.hpp.

WiringSituation& engine::WiringSituation::defineInput	(	uint	inPin,
		PNode	pred,
		uint	outPin
	)			[inline]

set up a connection leading to a specific input pin of the new node

Definition at line 139 of file nodewiring-def.hpp.

WiringSituation& engine::WiringSituation::resolveProcessor

(

asset::Proc const &

procAsset

)

[inline]

trigger resolving of the actual processing function

Definition at line 177 of file nodewiring-def.hpp.

References asset::Proc::resolveProcessor().

Here is the call graph for this function:

WiringSituation& engine::WiringSituation::setFlag

(

long

code

)

[inline]

set detail flags regarding the desired node operation mode

Definition at line 166 of file nodewiring-def.hpp.

---

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

• proc/engine/nodewiring-def.hpp