asset::Pipe Class Reference

#include <pipe.hpp>

Inheritance diagram for asset::Pipe:

[legend]

Collaboration diagram for asset::Pipe:

[legend]

List of all members.

---

Detailed Description

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

Definition at line 58 of file pipe.hpp.

Public Member Functions
virtual const ID< Pipe > &	getID () const
	<
const string &	getPipeID () const
const PProcPatt &	getProcPatt () const
void	switchProcPatt (PProcPatt &another)
	use another wiring template.
Static Public Member Functions
static PPipe	query (string properties)
	convenience shortcut for retrieving default configured pipes
Public Attributes
string	longDesc
	user visible qualification of the thing, unit or concept represented by this asset.
string	shortDesc
	user visible Name-ID.
Protected Member Functions
	Pipe (const Asset::Ident &, PProcPatt &wiring, const string &pipeID, string shortName="", string longName="")
	Create and register a new Pipe asset.
Private Attributes
const string	pipeID_
PProcPatt	wiringTemplate
Friends
class	StructFactory
class	StructFactoryImpl

---

Constructor & Destructor Documentation

asset::Pipe::Pipe	(	const Asset::Ident &	idi,
		PProcPatt &	wiring,
		const string &	pipeID,
		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.

Definition at line 39 of file pipe.cpp.

References shortDesc.

---

Member Function Documentation

virtual const ID<Pipe>& asset::Pipe::getID

(

)

const [inline, virtual]

<

Returns:

ID typed to asset::Pipe

Reimplemented from asset::Struct.

Definition at line 67 of file pipe.hpp.

PPipe asset::Pipe::query

(

string

properties

)

[static]

convenience shortcut for retrieving default configured pipes

Definition at line 59 of file pipe.cpp.

References asset::Struct::create.

void asset::Pipe::switchProcPatt

(

PProcPatt &

another

)

use another wiring template.

Triggers complete rebuild of the render engine.

Definition at line 65 of file pipe.cpp.

---

Member Data Documentation

string asset::Pipe::longDesc

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

preferably "in one line". To be localised.

Reimplemented from asset::Asset.

Definition at line 65 of file pipe.hpp.

string asset::Pipe::shortDesc

user visible Name-ID.

To be localised.

Reimplemented from asset::Asset.

Definition at line 64 of file pipe.hpp.

Referenced by Pipe().

---

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

• proc/asset/pipe.hpp
• proc/asset/pipe.cpp