WiringSituation Class Reference

#include "steam/engine/nodewiring-def.hpp"

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 71 of file nodewiring-def.hpp.

Public Member Functions
	WiringSituation ()
	A default WiringSituation doesn't specify any connections. More...
	WiringSituation (PNode predecessor)
	Continue the wiring by hooking directly into the output of an existing predecessor node.
lumiera::NodeID const &	createNodeID () const
WiringSituation &	defineInput (uint inPin, PNode pred, uint outPin)
	set up a connection leading to a specific input pin of the new node
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)
	set up the next input connection to a specific input pin, originating at a the next/sole output pin of the predecessor
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

Private Attributes
long	flags_
asset::Proc::ProcFunc *	function_

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

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 information later on.

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

Inheritance diagram for WiringSituation:

Collaboration diagram for WiringSituation:

---

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

• nodewiring-def.hpp