TimeGrid Class Reference

#include "steam/asset/meta/time-grid.hpp"

Description

Interface: a grid and scale definition for time quantisation.

This meta-Asset describes a coordinate system or reference scale for quantised time values. Especially it allows to define an actual implementation, which can then implicitly be used by lib::time::QuTime and for conversions into timecode.

Note

for this to work, the actual implementation classes returned by the builder or the static build function additionally expose an implementation of the lib::time::Quantiser API

Definition at line 77 of file time-grid.hpp.

Static Public Member Functions
static PGrid	build (FrameRate frames_per_second)
static PGrid	build (Symbol gridID, FrameRate frames_per_second)
static PGrid	build (Symbol gridID, FrameRate frames_per_second, Time origin)

Protected Member Functions
	TimeGrid (GridID const &)
Protected Member Functions inherited from Meta
	Meta (Asset::Ident const &idi)
template<typename TY >
	Meta (lib::idi::EntryID< TY > const &nameID)
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
Static Public Attributes inherited from Meta
static MetaFactory	create
	storage for the static MetaFactory instance
Public Attributes inherited from Asset
const Ident	ident
	Asset identification tuple.
Public Member Functions inherited from Meta
virtual const ID< Meta > &	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.
Public Member Functions inherited from Descriptor
virtual	~Descriptor ()
	this is an Interface
Public Member Functions inherited from Grid
virtual	~Grid ()
	this is an Interface
virtual FrameCnt	gridPoint (TimeValue const &raw) const =0
virtual Offset	gridLocal (TimeValue const &raw) const =0
virtual TimeValue	timeOf (FrameCnt gridPoint) const =0
virtual TimeValue	timeOf (FSecs gridTime, int=0) const =0
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

TimeGrid()

TimeGrid ( GridID const &  nameID )

protected

to be invoked indirectly by means of the Builder<TimeGrid>.

Todo:

drafted in 2010 – usage of the builder feels unsatisfactory as of 2018

Definition at line 48 of file time-grid.cpp.

Member Function Documentation

build() [1/3]

PGrid build ( FrameRate  frames_per_second )

static

Parameters

frames_per_second

automatically generates a generic grid name

Definition at line 157 of file time-grid.cpp.

References TimeGrid::build(), and Symbol::EMPTY.

Referenced by TimeGrid::build(), TimeGrid::build(), TimeQuantisation_test::checkGridBinding(), TimeQuantisation_test::checkMultipleGrids(), TimeQuantisation_test::checkSimpleUsage(), TimeGridBasics_test::createGrid_simplified(), TimeParsing_test::defineTestTimeGrids(), NodeFeed_test::feedParamNode(), TimeMutation_test::mutate_quantised(), TimeControl_test::run(), TimeMutation_test::run(), TimeFormats_test::run(), NodeBuilder_test::run(), and NodeLink_test::trigger_node_port_invocation().

Here is the call graph for this function:

Here is the caller graph for this function:

build() [2/3]

PGrid build ( Symbol  gridID, FrameRate  frames_per_second  )

static

Parameters

frames_per_second

grid origin is at Time::ZERO

Definition at line 163 of file time-grid.cpp.

References TimeGrid::build(), and Time::ZERO.

Here is the call graph for this function:

build() [3/3]

PGrid build ( Symbol  gridID, FrameRate  frames_per_second, Time  origin  )

static

Definition at line 170 of file time-grid.cpp.

Inheritance diagram for TimeGrid:

Collaboration diagram for TimeGrid:

---

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

• time-grid.hpp
• time-grid.cpp