Murl::Logic::BaseStepable Class Reference

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

#include <murl_logic_base_stepable.h>

Detailed Description

A helper class for simple use of the IStepable object.

A stepable object is created at object instantiation.

Inheritance diagram for Murl::Logic::BaseStepable:

Public Member Functions
	BaseStepable ()
	The default constructor. More...
	~BaseStepable () override
	The destructor. More...
	operator IStepablePtr ()
	Conversion operator. 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	Reset () override
	Implementation of IStepable::Reset() method.
void	ProcessTick (const Logic::IState *state) override
	Implementation of IStepable::ProcessTick() method. More...
void	FinishTick (const Logic::IState *state) override
	Implementation of IStepable::FinishTick() method. More...

Protected Member Functions
void	OnSetEnabled (Bool isEnabled) override
	Default implementation of IAppStepable::OnSetEnabled() method, this method is empty and can be overwritten. More...
void	OnReset () override
	Default implementation of IAppStepable::OnReset() method, this method is empty and can be overwritten.
void	OnProcessTick (const Logic::IState *state) override
	Default implementation of IAppStepable::OnProcessTick() method, this method is empty and can be overwritten. More...
void	OnFinishTick (const Logic::IState *state) override
	Default implementation of IAppStepable::OnFinishTick() method, this method is empty and can be overwritten. More...

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

Constructor & Destructor Documentation

BaseStepable()

Murl::Logic::BaseStepable::BaseStepable ( )

inline

The default constructor.

Creates a IStepable object.

~BaseStepable()

Murl::Logic::BaseStepable::~BaseStepable ( )

inlineoverride

The destructor.

Destroys the IStepable object.

Member Function Documentation

operator IStepablePtr()

Murl::Logic::BaseStepable::operator IStepablePtr ( )

inline

Conversion operator.

Returns

The IStepable interface.

OnSetEnabled()

void Murl::Logic::BaseStepable::OnSetEnabled ( Bool  isEnabled )

inlineoverrideprotectedvirtual

Default implementation of IAppStepable::OnSetEnabled() method, this method is empty and can be overwritten.

Parameters

isEnabled

true if enabled.

Implements Murl::Logic::IAppStepable.

Reimplemented in Murl::Logic::GraphInstanceObjects< InstanceObjectType >.

OnProcessTick()

void Murl::Logic::BaseStepable::OnProcessTick ( const Logic::IState *  state )

inlineoverrideprotectedvirtual

Default implementation of IAppStepable::OnProcessTick() method, this method is empty and can be overwritten.

Parameters

state

The IState object.

Implements Murl::Logic::IAppStepable.

Reimplemented in Murl::Logic::GraphInstanceObjects< InstanceObjectType >, and Murl::Logic::StateMachine< StateType, HashFunc >.

OnFinishTick()

void Murl::Logic::BaseStepable::OnFinishTick ( const Logic::IState *  state )

inlineoverrideprotectedvirtual

Default implementation of IAppStepable::OnFinishTick() method, this method is empty and can be overwritten.

Parameters

state

The IState object.

Implements Murl::Logic::IAppStepable.

Reimplemented in Murl::Logic::GraphInstanceObjects< InstanceObjectType >, and Murl::Logic::StateMachine< StateType, HashFunc >.

---

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

• murl_logic_base_stepable.h