SequencePlayerIndependentClock Class Reference

#include <sequenceplayerclock.h>

Public Member Functions
	SequencePlayerIndependentClock ()=default
	~SequencePlayerIndependentClock ()=default
	SequencePlayerIndependentClock (const SequencePlayerIndependentClock &)=delete
SequencePlayerIndependentClock &	operator= (const SequencePlayerIndependentClock &)=delete
bool	init (utility::ErrorState &errorState) override
void	start (Slot< double > &updateSlot) override
void	stop () override
Public Member Functions inherited from SequencePlayerClock
	SequencePlayerClock ()=default
	~SequencePlayerClock ()=default
	SequencePlayerClock (const SequencePlayerClock &)=delete
SequencePlayerClock &	operator= (const SequencePlayerClock &)=delete
Public Member Functions inherited from Resource
	Resource ()
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
virtual void	onDestroy ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
float	mFrequency = 1000.0f
	Property: 'Frequency' the update frequency in times per second (Hz) More...
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)
Protected Attributes inherited from SequencePlayerClock
Slot< double >	mSlot

Description

The SequencePlayerIndependentClock can be used to let the SequencePlayer be updated by a thread started by the SequencePlayerIndependentClock.

Inheritance diagram for SequencePlayerIndependentClock:

Collaboration diagram for SequencePlayerIndependentClock:

Constructor & Destructor Documentation

SequencePlayerIndependentClock() [1/2]

SequencePlayerIndependentClock ( )

default

Constructor

~SequencePlayerIndependentClock()

~SequencePlayerIndependentClock ( )

default

Destructor

SequencePlayerIndependentClock() [2/2]

SequencePlayerIndependentClock ( const SequencePlayerIndependentClock &  )

delete

Member Function Documentation

init()

bool init ( utility::ErrorState &  errorState )

overridevirtual

Initialization method

Parameters

errorState

contains any errors

Returns

true on success

Reimplemented from Object.

operator=()

SequencePlayerIndependentClock& operator= ( const SequencePlayerIndependentClock &  )

delete

start()

void start ( Slot< double > &  updateSlot )

overridevirtual

Called by sequence player upon initialization

Parameters

updateSlot

the update slot from the SequencePlayer that needs to be called

Implements SequencePlayerClock.

stop()

void stop ( )

overridevirtual

Called by the SequencePlayer when player is deconstructed

Implements SequencePlayerClock.

Member Data Documentation

mFrequency

float mFrequency = 1000.0f

Property: 'Frequency' the update frequency in times per second (Hz)