Murl::Logic::IStepableObserver Interface Referenceabstract

The IStepableObserver interface. More...

#include "murl_logic_i_stepable_observer.h"

Inherited by Murl::Logic::StepableObserver.

Public Member Functions

virtual Bool Add (IStepablePtr stepable)=0
 Add a stepable object to the observer. More...
 
virtual Bool Remove (IStepablePtr stepable)=0
 Remove a stepable object from the observer. More...
 
virtual Bool RemoveAt (UInt32 index)=0
 Remove a stepable object by index from the observer. More...
 
virtual void RemoveAll ()=0
 Remove all stepable objects from the observer.
 
virtual UInt32 GetNumberOfStepables () const =0
 Get the number of stepable objects in the observer. More...
 
virtual IStepablePtr GetStepable (UInt32 index) const =0
 Get a stepable object by index. More...
 
virtual void SetEnabled (Bool isEnabled)=0
 Notify IStepable::SetEnabled() to all observed objects. More...
 
virtual void Reset ()=0
 Notify IStepable::Reset() to all observed objects.
 
virtual void ProcessTick (const Logic::IState *state)=0
 Notify IStepable::ProcessTick() to all observed objects. More...
 
virtual void FinishTick (const Logic::IState *state)=0
 Notify IStepable::FinishTick() to all observed objects. More...
 

Detailed Description

The IStepableObserver interface.

The stepable observer notifies objects implementing the IStepable interface.
The IProcessor object provides a ready to use stepable observer.

Member Function Documentation

◆ Add()

virtual Bool Murl::Logic::IStepableObserver::Add ( IStepablePtr  stepable)
pure virtual

Add a stepable object to the observer.

Adding a stepable twice is not allowed.

Parameters
stepableThe stepable object to add.
Returns
true if successful.

◆ Remove()

virtual Bool Murl::Logic::IStepableObserver::Remove ( IStepablePtr  stepable)
pure virtual

Remove a stepable object from the observer.

Parameters
stepableThe stepable object to remove.
Returns
true if successful.

◆ RemoveAt()

virtual Bool Murl::Logic::IStepableObserver::RemoveAt ( UInt32  index)
pure virtual

Remove a stepable object by index from the observer.

A valid index is [0 .. GetNumberOfStepables() - 1].

Parameters
indexThe zero-based index of the stepable object to remove.
Returns
true if successful.

◆ GetNumberOfStepables()

virtual UInt32 Murl::Logic::IStepableObserver::GetNumberOfStepables ( ) const
pure virtual

Get the number of stepable objects in the observer.

Returns
The number of stepable objects.

◆ GetStepable()

virtual IStepablePtr Murl::Logic::IStepableObserver::GetStepable ( UInt32  index) const
pure virtual

Get a stepable object by index.

A valid index is [0 .. GetNumberOfStepables() - 1].

Parameters
indexThe zero-based index of the stepable object.
Returns
The stepable object or 0 if index is out of range.

◆ SetEnabled()

virtual void Murl::Logic::IStepableObserver::SetEnabled ( Bool  isEnabled)
pure virtual

Notify IStepable::SetEnabled() to all observed objects.

Parameters
isEnabledtrue for enable, false for disable.

◆ ProcessTick()

virtual void Murl::Logic::IStepableObserver::ProcessTick ( const Logic::IState state)
pure virtual

Notify IStepable::ProcessTick() to all observed objects.

Parameters
stateThe IState object.

◆ FinishTick()

virtual void Murl::Logic::IStepableObserver::FinishTick ( const Logic::IState state)
pure virtual

Notify IStepable::FinishTick() to all observed objects.

Parameters
stateThe IState object.

The documentation for this interface was generated from the following file:
  • murl_logic_i_stepable_observer.h


Copyright © 2011-2018 Spraylight GmbH.