Murl::Logic::BaseStepableObserver Class Reference

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

#include "murl_logic_base_stepable_observer.h"

Inheritance diagram for Murl::Logic::BaseStepableObserver:

Public Member Functions
	BaseStepableObserver ()
	The default constructor. More...
virtual	~BaseStepableObserver ()
	The destructor. More...
	operator IStepableObserverPtr () const
	Conversion operator. More...
IStepableObserverPtr	GetStepableObserver () const
	Get the stepable observer interface. More...
Bool	Add (IStepablePtr stepable) const
	Forward to IStepableObserver::Add() method. More...
Bool	Remove (IStepablePtr stepable) const
	Forward to IStepableObserver::Remove() method. More...
Bool	RemoveAt (UInt32 index) const
	Forward to IStepableObserver::RemoveAt() method. More...
UInt32	GetNumberOfStepables () const
	Forward to IStepableObserver::GetNumberOfStepables() method. More...
IStepablePtr	GetStepable (UInt32 index) const
	Forward to IStepableObserver::GetStepable() method. More...
void	SetEnabled (Bool isEnabled) const
	Forward to IStepableObserver::SetEnabled() method. More...
void	Reset () const
	Forward to IStepableObserver::Reset() method.
void	ProcessTick (const Logic::IState *state) const
	Forward to IStepableObserver::ProcessTick() method. More...
void	FinishTick (const Logic::IState *state) const
	Forward to IStepableObserver::FinishTick() method. More...
void	RemoveAll () const
	Forward to IStepableObserver::RemoveAll() method.
Public Member Functions inherited from Murl::NonCopyable
	NonCopyable ()=default
	The default constructor.

Detailed Description

A helper class for simple use of the IStepableObserver object.

A stepable observer is created at object instantiation.

Constructor & Destructor Documentation

BaseStepableObserver()

Murl::Logic::BaseStepableObserver::BaseStepableObserver ( )

inline

The default constructor.

Creates a IStepableObserver object.

~BaseStepableObserver()

virtual Murl::Logic::BaseStepableObserver::~BaseStepableObserver ( )

inlinevirtual

The destructor.

Destroys the IStepableObserver object.

Member Function Documentation

operator IStepableObserverPtr()

Murl::Logic::BaseStepableObserver::operator IStepableObserverPtr ( ) const

inline

Conversion operator.

Returns

The IStepableObserver interface.

GetStepableObserver()

IStepableObserverPtr Murl::Logic::BaseStepableObserver::GetStepableObserver ( ) const

inline

Get the stepable observer interface.

Returns

The IStepableObserver interface.

Add()

Bool Murl::Logic::BaseStepableObserver::Add ( IStepablePtr  stepable ) const

inline

Forward to IStepableObserver::Add() method.

Parameters

stepable

The stepable object to add.

Returns

true if successful.

Remove()

Bool Murl::Logic::BaseStepableObserver::Remove ( IStepablePtr  stepable ) const

inline

Forward to IStepableObserver::Remove() method.

Parameters

stepable

The stepable object to remove.

Returns

true if successful.

RemoveAt()

Bool Murl::Logic::BaseStepableObserver::RemoveAt ( UInt32  index ) const

inline

Forward to IStepableObserver::RemoveAt() method.

Parameters

index

The zero-based index of the stepable object to remove.

Returns

true if successful.

GetNumberOfStepables()

UInt32 Murl::Logic::BaseStepableObserver::GetNumberOfStepables ( ) const

inline

Forward to IStepableObserver::GetNumberOfStepables() method.

Returns

The number of stepable objects.

GetStepable()

IStepablePtr Murl::Logic::BaseStepableObserver::GetStepable ( UInt32  index ) const

inline

Forward to IStepableObserver::GetStepable() method.

Parameters

index

The zero-based index of the stepable object.

Returns

The stepable object or 0 if index is out of range.

SetEnabled()

void Murl::Logic::BaseStepableObserver::SetEnabled ( Bool  isEnabled ) const

inline

Forward to IStepableObserver::SetEnabled() method.

Parameters

isEnabled

true for enable, false for disable.

ProcessTick()

void Murl::Logic::BaseStepableObserver::ProcessTick ( const Logic::IState *  state ) const

inline

Forward to IStepableObserver::ProcessTick() method.

Parameters

state

The IState object.

FinishTick()

void Murl::Logic::BaseStepableObserver::FinishTick ( const Logic::IState *  state ) const

inline

Forward to IStepableObserver::FinishTick() method.

Parameters

state

The IState object.

---

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

• murl_logic_base_stepable_observer.h