#include "steam/asset/pipe.hpp"

Description

structural asset corresponding to the part of the model forming a processing pipe for generating media output

Definition at line 70 of file pipe.hpp.

Public Attributes
string	shortDesc

string	longDesc

Public Attributes inherited from Asset
const Ident	ident
	Asset identification tuple.

Static Public Member Functions
static PPipe	query (string const &properties)
	convenience shortcut for retrieving default configured pipes

static PPipe	lookup (ID< Pipe > id)
	convenience shortcut for lookup by id

Public Member Functions
virtual const ID< Pipe > &	getID () const
	<

string const &	getPipeID () const

StreamType::ID	getStreamID () const

PProcPatt const &	getProcPatt () const

void	switchProcPatt (PProcPatt &another)
	use another wiring template.

Public Member Functions inherited from Asset
bool	operator== (Asset const &oa) const

auto	operator<=> (Asset const &oa) const

virtual	operator string () const

const vector< PAsset > &	getParents () const
	List of entities this asset depends on or requires to be functional.

const vector< PAsset > &	getDependant () const
	All the other assets requiring this asset to be functional.

bool	isActive () const
	weather this asset is switched on and consequently included in the fixture and participates in rendering

bool	enable (bool on=true)
	change the enabled status of this asset.

Friends
class	StructFactoryImpl

Protected Member Functions
	Pipe (Asset::Ident const &, string const &streamID, PProcPatt &wiring, string shortName="", string longName="")
	Create and register a new Pipe asset.

Protected Member Functions inherited from Struct
	Struct (const Asset::Ident &idi)

Protected Member Functions inherited from Asset
	Asset (const Ident &idi)
	Asset is a Interface class; usually, objects of concrete subclasses are created via specialised Factories.

virtual	~Asset ()=0

virtual void	unlink ()
	release all links to other Asset objects held internally.

virtual void	unlink (IDA target)
	variant of unlink() dropping only the links to the given specific Asset, leaving all other links intact.

void	defineDependency (PAsset parent)
	establish a connection between this and the given parent asset, denoting we are in some way dependent on the parent.

void	defineDependency (Asset &parent)

Private Attributes
PProcPatt	wiringTemplate_

StreamType::ID	streamID_

Additional Inherited Members
Static Public Attributes inherited from Struct
static StructFactory	retrieve
	storage for the static StructFactory instance

Protected Attributes inherited from Asset
const ID< Asset >	id
	Asset primary key.

set< string >	groups
	additional classification, selections or departments this asset belongs to.

const string	shortDesc
	user visible Name-ID.

const string	longDesc
	user visible qualification of the thing, unit or concept represented by this asset.

vector< PAsset >	parents

vector< PAsset >	dependants

bool	enabled

Constructor & Destructor Documentation

◆ Pipe()

Pipe	(	Asset::Ident const &	idi,
		string const &	streamID,
		PProcPatt &	wiring,
		string	shortName = `""`,
		string	longName = `""`
	)

protected

Create and register a new Pipe asset.

Usually, this is triggered automatically by referring to the pipeID. When building the render network, the given processing pattern will be executed, allowing for all sorts of default wiring.

Parameters

streamID /////////////////////////////////////TICKET #648

Definition at line 37 of file pipe.cpp.

References Asset::Ident::isValid(), and Pipe::shortDesc.

Here is the call graph for this function:

Member Function Documentation

◆ getID()

virtual const ID< Pipe > & getID ( ) const

inlinevirtual

<

Returns: ID typed to asset::Pipe

Reimplemented from Struct.

Definition at line 80 of file pipe.hpp.

References Asset::getID().

Here is the call graph for this function:

◆ getPipeID()

string const & getPipeID ( ) const

inline

Definition at line 92 of file pipe.hpp.

References Asset::ident, and Asset::Ident::name.

◆ getStreamID()

StreamType::ID getStreamID ( ) const

inline

Definition at line 93 of file pipe.hpp.

References Pipe::streamID_.

◆ getProcPatt()

PProcPatt const & getProcPatt ( ) const

inline

Definition at line 94 of file pipe.hpp.

References Pipe::wiringTemplate_.

◆ switchProcPatt()

void switchProcPatt ( PProcPatt & another )

use another wiring template.

Triggers complete rebuild of the render engine.

Definition at line 74 of file pipe.cpp.

References Pipe::wiringTemplate_.

◆ query()

PPipe query ( string const & properties )

static

convenience shortcut for retrieving default configured pipes

Definition at line 57 of file pipe.cpp.

References Struct::retrieve.

Referenced by BasicPipe_test::create_or_ref(), BasicPipe_test::create_using_default(), OutputMapping_test::default_mapping(), BasicPipe_test::dependProcPatt(), DefsManagerImpl_test::forget(), LocatingPin::LocatingSolution::getPipe(), steam::fixture::test::anonymous_namespace{fixture-change-detector-test.cpp}::getPipe(), steam::fixture::test::anonymous_namespace{model-port-registry-test.cpp}::getPipe(), steam::fixture::test::anonymous_namespace{segmentation-integration-test.cpp}::getPipe(), steam::play::test::getPipe(), OutputMapping_test::instance_copy(), OutputMapping_test::map_and_retrieve(), DispatcherInterface_test::resolveModelPort(), DefsManager_test::retrieveConstrainedDefault(), DefsManager_test::retrieveSimpleDefault(), EngineInterface_test::run(), and TimelineSequenceHandling_test::verify_creation().

Here is the caller graph for this function:

◆ lookup()

PPipe lookup ( ID< Pipe > id )

static

convenience shortcut for lookup by id

Parameters

id	asset-ID of the pipe to retrieve

Exceptions

error::Invalid when not found

Definition at line 67 of file pipe.cpp.

References AssetManager::instance.

Referenced by OutputMapping_test::DummyDef::buildQuery(), ID< Pipe >::operator PPipe(), OutputMapping_test::DummyDef::output(), and ID< Pipe >::streamType().

Here is the caller graph for this function:

Member Data Documentation

◆ wiringTemplate_

PProcPatt wiringTemplate_

private

Definition at line 73 of file pipe.hpp.

Referenced by Pipe::getProcPatt(), and Pipe::switchProcPatt().

◆ streamID_

StreamType::ID streamID_

private

Definition at line 74 of file pipe.hpp.

Referenced by Pipe::getStreamID().

◆ shortDesc

string shortDesc

Definition at line 77 of file pipe.hpp.

Referenced by Pipe::Pipe().

◆ longDesc

string longDesc

Definition at line 78 of file pipe.hpp.

Friends And Related Symbol Documentation

◆ StructFactoryImpl

friend class StructFactoryImpl

friend

Definition at line 89 of file pipe.hpp.

Inheritance diagram for Pipe:

Collaboration diagram for Pipe:

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

Description

Public Attributes

Static Public Member Functions

Public Member Functions

Friends

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Pipe()

Member Function Documentation

◆ getID()

◆ getPipeID()

◆ getStreamID()

◆ getProcPatt()

◆ switchProcPatt()

◆ query()

◆ lookup()

Member Data Documentation

◆ wiringTemplate_

◆ streamID_

◆ shortDesc

◆ longDesc

Friends And Related Symbol Documentation

◆ StructFactoryImpl