Lumiera  0.pre.03
»edityourfreedom«
Proc Class Referenceabstract

#include "proc/asset/proc.hpp"

Description

key abstraction: data processing asset

Todo:
just a stub, have to figure out what a asset::Proc is

Definition at line 72 of file proc.hpp.

Public Types

typedef StreamType::ImplFacade::DataBuffer Buff
 
typedef BuffPBuff
 
typedef void() ProcFunc(PBuff)
 

Public Member Functions

virtual const ID< Proc > & getID () const
 < More...
 
virtual ProcFuncresolveProcessor () const =0
 resolve any plugin and configuration info to yield the actual media data processing function. More...
 
- Public Member Functions inherited from Asset
bool enable (bool on=true)
 change the enabled status of this asset. More...
 
const vector< PAsset > & getDependant () const
 All the other assets requiring this asset to be functional. More...
 
const vector< PAsset > & getParents () const
 List of entities this asset depends on or requires to be functional. More...
 
bool isActive () const
 weather this asset is switched on and consequently included in the fixture and participates in rendering More...
 
virtual operator string () const
 
bool operator< (Asset const &oa) const
 
bool operator== (Asset const &oa) const
 

Static Public Attributes

static ProcFactory create
 storage for the static ProcFactory instance More...
 

Friends

class ProcFactory
 

Protected Member Functions

 Proc (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. More...
 
virtual ~Asset ()=0
 
void defineDependency (PAsset parent)
 establish a connection between this and the given parent asset, denoting we are in some way dependent on the parent. More...
 
void defineDependency (Asset &parent)
 
virtual void unlink ()
 release all links to other Asset objects held internally. More...
 
virtual void unlink (IDA target)
 variant of unlink() dropping only the links to the given specific Asset, leaving all other links intact. More...
 

Additional Inherited Members

- Public Attributes inherited from Asset
const Ident ident
 Asset identification tuple. More...
 
- Protected Attributes inherited from Asset
vector< PAssetdependants
 
bool enabled
 
set< string > groups
 additional classification, selections or departments this asset belongs to. More...
 
const ID< Assetid
 Asset primary key. More...
 
const string longDesc
 user visible qualification of the thing, unit or concept represented by this asset. More...
 
vector< PAssetparents
 
const string shortDesc
 user visible Name-ID. More...
 

Member Typedef Documentation

◆ Buff

Definition at line 82 of file proc.hpp.

◆ PBuff

typedef Buff* PBuff

Definition at line 83 of file proc.hpp.

◆ ProcFunc

typedef void() ProcFunc(PBuff)

Definition at line 84 of file proc.hpp.

Constructor & Destructor Documentation

◆ Proc()

Proc ( const Asset::Ident idi)
inlineprotected

Definition at line 102 of file proc.hpp.

Member Function Documentation

◆ getID()

virtual const ID<Proc>& getID ( ) const
inlinevirtual

<

Returns
ID of kind Proc

Reimplemented from Asset.

Definition at line 77 of file proc.hpp.

References Asset::getID().

+ Here is the call graph for this function:

◆ resolveProcessor()

virtual ProcFunc* resolveProcessor ( ) const
pure virtual

resolve any plugin and configuration info to yield the actual media data processing function.

Returns
a function ready to be invoked; either the "real thing" or a suitable placeholder.
Exceptions
lumiera::error::Fatalif unable to provide any usable function or placeholder. This case can be considered exceptional and justifies a subsystem failure.

Implemented in Effect.

Referenced by WiringSituation::resolveProcessor().

+ Here is the caller graph for this function:

Member Data Documentation

◆ create

ProcFactory create
static

storage for the static ProcFactory instance

Definition at line 75 of file proc.hpp.

Friends And Related Function Documentation

◆ ProcFactory

friend class ProcFactory
friend

Definition at line 103 of file proc.hpp.

+ Inheritance diagram for Proc:
+ Collaboration diagram for Proc:

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