ProcPatt Class Reference

#include "steam/asset/procpatt.hpp"

Description

"Processing Pattern" is a structural Asset representing information how to build some part of the render engine's processing nodes network.

Definition at line 52 of file procpatt.hpp.

Public Member Functions
lib::P< ProcPatt >	newCopy (string newID) const
	create a new ProcPatt asset as a literal copy of this one.
ProcPatt &	attach (Symbol where, PProc &node)
	extend the processing instructions to add some Effect
ProcPatt &	operator+= (PProcPatt &toReuse)
	extend the processing instructions by reference to another ProcPatt, which will be "executed" at this point while building.
Public Member Functions inherited from Struct
virtual const ID< Struct > &	getID () const
	<
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
	ProcPatt (const Asset::Ident &idi)
	new processing pattern with empty instruction list.
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 Member Functions
	~ProcPatt ()
	emit VTable and member destructors here...
	ProcPatt (const Asset::Ident &, const InstructionSequence &)

Private Attributes
InstructionSequence	instructions_

Additional Inherited Members
Static Public Attributes inherited from Struct
static StructFactory	retrieve
	storage for the static StructFactory instance
Public Attributes inherited from Asset
const Ident	ident
	Asset identification tuple.
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

~ProcPatt()

~ProcPatt ( )

private

emit VTable and member destructors here...

Definition at line 33 of file procpatt.cpp.

ProcPatt() [1/2]

ProcPatt ( const Asset::Ident &  idi, const InstructionSequence &  instru  )

private

used for creating a clone copy

Definition at line 49 of file procpatt.cpp.

ProcPatt() [2/2]

ProcPatt ( const Asset::Ident &  idi )

explicitprotected

new processing pattern with empty instruction list.

Todo:

preliminary implementation, storing the capabilities in the asset name field. We can do better, when it's clear what capabilities we need

Definition at line 42 of file procpatt.cpp.

Member Function Documentation

newCopy()

lib::P< ProcPatt > newCopy

(

string

newID

)

const

create a new ProcPatt asset as a literal copy of this one.

The new ProcPatt can then be customised independently of the original one. This allows using some ProcPatt as a template for creating more specialised patterns.

Definition at line 65 of file procpatt.cpp.

References Asset::ident, AssetManager::instance, ProcPatt::instructions_, and Asset::Ident::name.

Referenced by BasicPipe_test::dependProcPatt().

Here is the caller graph for this function:

attach()

ProcPatt & attach	(	Symbol	where,
		PProc &	node
	)

extend the processing instructions to add some Effect

Parameters

where	denotes the insertion point where to attach the Effect
node	prototype of the Effect to be inserted when building.

Definition at line 82 of file procpatt.cpp.

References ProcPatt::instructions_.

operator+=()

ProcPatt & operator+=

(

PProcPatt &

toReuse

)

extend the processing instructions by reference to another ProcPatt, which will be "executed" at this point while building.

This allowes for using simple PorcPatt instances as building blocks to define more complicated patterns.

Definition at line 109 of file procpatt.cpp.

References ProcPatt::instructions_.

Member Data Documentation

instructions_

InstructionSequence instructions_

private

Definition at line 55 of file procpatt.hpp.

Referenced by ProcPatt::attach(), ProcPatt::newCopy(), and ProcPatt::operator+=().

Friends And Related Symbol Documentation

StructFactoryImpl

friend class StructFactoryImpl

friend

Definition at line 63 of file procpatt.hpp.

Inheritance diagram for ProcPatt:

Collaboration diagram for ProcPatt:

---

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

• procpatt.hpp
• procpatt.cpp