Lumiera  0.pre.03
»edit your freedom«
Struct Class Reference

#include "steam/asset/struct.hpp"

Description

key abstraction: structural asset Created automatically as a sideeffect of building the structure of the high-level-model (session contents), thus providing IDs for later referral, search and attachment of metadata.

Examples being tracks, sequences, timelines, pipes, processing patterns

Note
embedded access point to instance creation or retrieval through the static field retrieve
Todo:
the actual meaning of a "structural asset" needs to be sharpened and evolved. The idea is to have a generic mechanism for attaching properties and relations. This will become relevant once we build the real query subsystem. Right now (as of 1/2015), asset::Struct is just an ID provider. //////////////////////////////////TICKET #1156 : do we need the distinction between STRUCT and META?

Definition at line 113 of file struct.hpp.

Public Member Functions

virtual const ID< Struct > & getID () const
 < 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 StructFactory retrieve
 storage for the static StructFactory instance
 

Protected Member Functions

 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. 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.
 
- 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.
 
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 Function Documentation

◆ getID()

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

<

Returns
ID of kind asset::Struct

Reimplemented from Asset.

Reimplemented in Pipe.

Definition at line 119 of file struct.hpp.

References Struct::getID().

Referenced by Struct::getID().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
+ Inheritance diagram for Struct:
+ Collaboration diagram for Struct:

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