#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 104 of file struct.hpp.

Static Public Attributes
static StructFactory	retrieve
	storage for the static StructFactory instance

Public Member Functions
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.

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.

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)

Additional Inherited Members
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

◆ Struct()

Struct ( const Asset::Ident & idi )

inlineprotected

Definition at line 118 of file struct.hpp.

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 110 of file struct.hpp.

References Asset::getID().

Referenced by BasicPipe_test::dependProcPatt().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ retrieve

StructFactory retrieve

static

storage for the static StructFactory instance

Definition at line 107 of file struct.hpp.

Referenced by SessionModifyParts_test::addForks(), BasicPipe_test::create_using_default(), BasicPipe_test::createExplicit(), DefsManagerImpl_test::define_and_search(), steam::mobject::session::query::anonymous_namespace{fake-configrules.cpp}::entry_Struct(), MockTable::fabricate_just_new_Pipe(), MockTable::fabricate_matching_new_Pipe(), MockTable::fabricate_ProcPatt_on_demand(), MockTable::fabricate_Sequence_on_demand(), MockTable::fabricate_Timeline_on_demand(), steam::fixture::test::anonymous_namespace{fixture-change-detector-test.cpp}::getTimeline(), steam::fixture::test::anonymous_namespace{model-port-registry-test.cpp}::getTimeline(), steam::fixture::test::anonymous_namespace{segmentation-integration-test.cpp}::getTimeline(), steam::play::test::getTimeline(), OutputMapping< DEF >::operator[](), Pipe::query(), DefsManager_test::retrieveSimpleDefault(), TimelineSequenceHandling_test::verify_creation(), SessionElementTracker_test::verify_integration(), TimelineSequenceHandling_test::verify_removalBinding(), TimelineSequenceHandling_test::verify_removalSequence(), TimelineSequenceHandling_test::verify_retrieval(), and DefsManager_test::verifyRemoval().

Inheritance diagram for Struct:

Collaboration diagram for Struct:

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

Description

Static Public Attributes

Public Member Functions