The ITimeframe interface implementation. More...

#include "murl_logic_timeframe.h"

Inheritance diagram for Murl::Logic::Timeframe:

Public Member Functions

 ~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...
 

Static Public Member Functions

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

Detailed Description

The ITimeframe interface implementation.

Member Function Documentation

◆ Create()

static ITimeframePtr Murl::Logic::Timeframe::Create ( )
static

Create a timeframe object.

Returns
The created timeframe object, or null if failed.

◆ ProcessTick()

void Murl::Logic::Timeframe::ProcessTick ( const Logic::IState state)
overridevirtual

Implementation of IStepable::ProcessTick() method.

Parameters
stateThe IState object.

Reimplemented from Murl::Logic::Stepable.

◆ GetStepable()

IStepablePtr Murl::Logic::Timeframe::GetStepable ( )
overridevirtual

Implementation of Timeframe::GetStepable() method.

Returns
The stepable interface shared pointer.

Implements Murl::Logic::ITimeframe.

Referenced by Murl::Logic::BaseTimeframe::operator IStepablePtr().

◆ Start()

void Murl::Logic::Timeframe::Start ( Real  endTime)
overridevirtual

Implementation of Timeframe::Start(Real endTime) method.

Parameters
endTimeThe time interval in seconds.

Implements Murl::Logic::ITimeframe.

◆ SetCurrentTime()

Bool Murl::Logic::Timeframe::SetCurrentTime ( Real  time)
overridevirtual

Implementation of Timeframe::SetCurrentTime() method.

Parameters
timeThe current time in seconds.
Returns
true if successful.

Implements Murl::Logic::ITimeframe.

◆ Finish()

Bool Murl::Logic::Timeframe::Finish ( )
overridevirtual

Implementation of Timeframe::Finish() method.

Returns
true if successful.

Implements Murl::Logic::ITimeframe.

◆ IsRunning()

Bool Murl::Logic::Timeframe::IsRunning ( ) const
overridevirtual

Implementation of Timeframe::IsRunning() method.

Returns
true if running.

Implements Murl::Logic::ITimeframe.

◆ WasStarted()

Bool Murl::Logic::Timeframe::WasStarted ( ) const
overridevirtual

Implementation of Timeframe::WasStarted() method.

Returns
true if started.

Implements Murl::Logic::ITimeframe.

◆ WasRunning()

Bool Murl::Logic::Timeframe::WasRunning ( ) const
overridevirtual

Implementation of Timeframe::WasRunning() method.

Returns
true if finished.

Implements Murl::Logic::ITimeframe.

◆ IsOrWasRunning()

Bool Murl::Logic::Timeframe::IsOrWasRunning ( ) const
overridevirtual

Implementation of Timeframe::IsOrWasRunning() method.

Returns
true if IsRunning() or WasRunning() is true.

Implements Murl::Logic::ITimeframe.

◆ HasPassedTime()

Bool Murl::Logic::Timeframe::HasPassedTime ( Real  time) const
overridevirtual

Implementation of Timeframe::HasPassedTime() method.

Parameters
timeThe time to check in seconds.
Returns
true if the current time has passed a specified time within the most recent tick.

Implements Murl::Logic::ITimeframe.

◆ SetTimeScale()

Bool Murl::Logic::Timeframe::SetTimeScale ( Real  timeScale)
overridevirtual

Implementation of Timeframe::SetTimeScale() method.

Parameters
timeScaleThe time scale factor.
Returns
true if successful.

Implements Murl::Logic::ITimeframe.

◆ GetTimeScale()

Real Murl::Logic::Timeframe::GetTimeScale ( ) const
overridevirtual

Implementation of Timeframe::GetTimeScale() method.

Returns
The time scale factor.

Implements Murl::Logic::ITimeframe.

◆ SetEndTime()

Bool Murl::Logic::Timeframe::SetEndTime ( Real  endTime)
overridevirtual

Implementation of Timeframe::SetEndTime() method.

Parameters
endTimeThe end time in seconds.
Returns
true if successful.

Implements Murl::Logic::ITimeframe.

◆ GetEndTime()

Real Murl::Logic::Timeframe::GetEndTime ( ) const
overridevirtual

Implementation of Timeframe::GetEndTime() method.

Returns
The end time in seconds.

Implements Murl::Logic::ITimeframe.

◆ GetCurrentTime()

Double Murl::Logic::Timeframe::GetCurrentTime ( ) const
overridevirtual

Implementation of Timeframe::GetCurrentTime() method.

Returns
The current time in seconds.

Implements Murl::Logic::ITimeframe.

◆ GetRemainingTime()

Double Murl::Logic::Timeframe::GetRemainingTime ( ) const
overridevirtual

Implementation of Timeframe::GetRemainingTime() method.

Returns
The remaining time in seconds.

Implements Murl::Logic::ITimeframe.


The documentation for this class was generated from the following file:
  • murl_logic_timeframe.h


Copyright © 2011-2022 Spraylight GmbH.