Murl::Logic::BaseTimeframe Class Reference

A helper class for simple use of the ITimeframe object. More...

#include <murl_logic_base_timeframe.h>

Detailed Description

A helper class for simple use of the ITimeframe object.

A timeframe is created at object instantiation.

Inheritance diagram for Murl::Logic::BaseTimeframe:

Public Member Functions
	BaseTimeframe ()
	The default constructor. More...
	~BaseTimeframe () override
	The destructor. More...
	operator IStepablePtr ()
	Conversion operator. More...
	operator ITimeframePtr ()
	Conversion operator. More...
Public Member Functions inherited from Murl::Logic::Timeframe
	~Timeframe () override
	The destructor.
void	ProcessTick (const Logic::IState *state) override
	Implementation of IStepable::ProcessTick() method. More...
IStepablePtr	GetStepable () override
	Implementation of Timeframe::GetStepable() method. More...
void	Reset () override
	Implementation of Timeframe::Reset() method.
void	Start () override
	Implementation of Timeframe::Start() method.
void	Start (Real endTime) override
	Implementation of Timeframe::Start(Real endTime) method. More...
Bool	SetCurrentTime (Real time) override
	Implementation of Timeframe::SetCurrentTime() method. More...
Bool	Finish () override
	Implementation of Timeframe::Finish() method. More...
Bool	IsRunning () const override
	Implementation of Timeframe::IsRunning() method. More...
Bool	WasStarted () const override
	Implementation of Timeframe::WasStarted() method. More...
Bool	WasRunning () const override
	Implementation of Timeframe::WasRunning() method. More...
Bool	IsOrWasRunning () const override
	Implementation of Timeframe::IsOrWasRunning() method. More...
Bool	HasPassedTime (Real time) const override
	Implementation of Timeframe::HasPassedTime() method. More...
Bool	SetTimeScale (Real timeScale) override
	Implementation of Timeframe::SetTimeScale() method. More...
Real	GetTimeScale () const override
	Implementation of Timeframe::GetTimeScale() method. More...
Bool	SetEndTime (Real endTime) override
	Implementation of Timeframe::SetEndTime() method. More...
Real	GetEndTime () const override
	Implementation of Timeframe::GetEndTime() method. More...
Double	GetCurrentTime () const override
	Implementation of Timeframe::GetCurrentTime() method. More...
Double	GetRemainingTime () const override
	Implementation of Timeframe::GetRemainingTime() method. More...
Public Member Functions inherited from Murl::Logic::Stepable
	~Stepable () override
	The destructor.
Bool	SetAppStepable (IAppStepablePtr appStepable) override
	Implementation of IStepable::SetAppStepable() method. More...
void	SetEnabled (Bool isEnabled) override
	Implementation of IStepable::SetEnabled() method. More...
Bool	IsEnabled () const override
	Implementation of IStepable::IsEnabled() method. More...
void	FinishTick (const Logic::IState *state) override
	Implementation of IStepable::FinishTick() method. More...

Additional Inherited Members
Static Public Member Functions inherited from Murl::Logic::Timeframe
static ITimeframePtr	Create ()
	Create a timeframe object. More...
Static Public Member Functions inherited from Murl::Logic::Stepable
static IStepablePtr	Create ()
	Create a stepable object. More...

Constructor & Destructor Documentation

BaseTimeframe()

Murl::Logic::BaseTimeframe::BaseTimeframe ( )

inline

The default constructor.

Creates a ITimeframe object.

~BaseTimeframe()

Murl::Logic::BaseTimeframe::~BaseTimeframe ( )

inlineoverride

The destructor.

Destroys the ITimeframe object.

Member Function Documentation

operator IStepablePtr()

Murl::Logic::BaseTimeframe::operator IStepablePtr ( )

inline

Conversion operator.

Returns

The IStepable interface.

operator ITimeframePtr()

Murl::Logic::BaseTimeframe::operator ITimeframePtr ( )

inline

Conversion operator.

Returns

The ITimeframe interface.

---

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

• murl_logic_base_timeframe.h