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

#include "murl_logic_base_processor.h"

Inheritance diagram for Murl::Logic::BaseProcessor:

Public Member Functions

 BaseProcessor (IFactory *factory)
 The constructor. More...
 
 ~BaseProcessor () override
 The destructor. More...
 
 operator IProcessorPtr () const
 Conversion operator. More...
 
IProcessorPtr GetProcessor () const
 Get the processor interface. More...
 
Bool SetAppProcessor (IAppProcessorPtr appProcessor) const
 Forward to IProcessor::SetAppProcessor() method. More...
 
Bool IsInitialized () const
 Forward to IProcessor::IsInitialized() method. More...
 
void SetEnabled (Bool isEnabled) const
 Forward to IProcessor::SetEnabled() method. More...
 
Bool IsEnabled () const
 Forward to IProcessor::IsEnabled() method. More...
 
Bool AddChild (IProcessorPtr processor) const
 Forward to IProcessor::AddChild() method. More...
 
Bool RemoveChild (IProcessorPtr processor) const
 Forward to IProcessor::RemoveChild() method. More...
 
Bool InitAddChild (const IState *state, IProcessorPtr processor) const
 Forward to IProcessor::InitAddChild() method. More...
 
Bool RemoveDeInitChild (const IState *state, IProcessorPtr processor) const
 Forward to IProcessor::RemoveDeInitChild() method. More...
 
UInt32 GetNumberOfChildren () const
 Forward to IProcessor::GetNumberOfChildren() method. More...
 
IProcessorPtr GetChild (UInt32 index) const
 Forward to IProcessor::GetChild() method. More...
 
Bool AddStepable (IStepablePtr stepable) const
 Forward to IProcessor::AddStepable() method. More...
 
Bool RemoveStepable (IStepablePtr stepable) const
 Forward to IProcessor::RemoveStepable() method. More...
 
Logic::IStepableObserverPtr GetStepableObserver () const
 Forward to IProcessor::GetStepableObserver() method. More...
 
Bool AddGraphNode (IObservableNodePtr observableNode) const
 Forward to IProcessor::AddGraphNode() method. More...
 
Bool RemoveGraphNode (IObservableNodePtr observableNode) const
 Forward to IProcessor::RemoveGraphNode() method. More...
 
Bool AreGraphNodesValid () const
 Forward to IProcessor::AreGraphNodesValid() method. More...
 
INodeObserverPtr GetNodeObserverPtr () const
 Forward to IProcessor::GetNodeObserver() method. More...
 
INodeObserverGetNodeObserver () const
 Get the processor's node observer interface pointer. More...
 

Protected Member Functions

Bool OnInit (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnInit() method, this method is empty and can be overwritten. More...
 
Bool OnDeInit (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnDeInit() method, this method is empty and can be overwritten. More...
 
void OnProcessTick (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnProcessTick() method, this method is empty and can be overwritten. More...
 
void OnProcessTickChildren (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnProcessTickChildren() method, this method is empty and can be overwritten. More...
 
void OnProcessFrame (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnProcessFrame() method, this method is empty and can be overwritten. More...
 
void OnProcessFrameChildren (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnProcessFrameChildren() method, this method is empty and can be overwritten. More...
 
void OnFinishTick (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnFinishTick() method, this method is empty and can be overwritten. More...
 
void OnFinishTickChildren (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnFinishTickChildren() method, this method is empty and can be overwritten. More...
 
void OnFinishFrame (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnFinishFrame() method, this method is empty and can be overwritten. More...
 
void OnFinishFrameChildren (const Logic::IState *state) override
 Default implementation of IAppProcessor::OnFinishFrameChildren() method, this method is empty and can be overwritten. More...
 
void OnPackageWillBeLoaded (const Logic::IState *state, IPackage *package) override
 Default implementation of IAppProcessor::OnPackageWillBeLoaded() method, this method is empty and can be overwritten. More...
 
void OnPackageWasLoaded (const Logic::IState *state, IPackage *package) override
 Default implementation of IAppProcessor::OnPackageWasLoaded() method, this method is empty and can be overwritten. More...
 
void OnPackageFailedLoading (const Logic::IState *state, IPackage *package) override
 Default implementation of IAppProcessor::OnPackageFailedLoading() method, this method is empty and can be overwritten. More...
 
void OnPackageWillBeUnloaded (const Logic::IState *state, IPackage *package) override
 Default implementation of IAppProcessor::OnPackageWillBeUnloaded() method, this method is empty and can be overwritten. More...
 
void OnPackageWasUnloaded (const Logic::IState *state, IPackage *package) override
 Default implementation of IAppProcessor::OnPackageWasUnloaded() method, this method is empty and can be overwritten. More...
 
void OnPackageFailedUnloading (const Logic::IState *state, IPackage *package) override
 Default implementation of IAppProcessor::OnPackageFailedUnloading() method, this method is empty and can be overwritten. More...
 
void OnRunStateChanged (const Logic::IState *state, IEnums::AppRunState currentState, IEnums::AppRunState previousState) override
 Default implementation of IAppProcessor::OnRunStateChanged() method, this method is empty and can be overwritten. More...
 
void OnSetEnabled (Bool isEnabled) override
 Default implementation of IAppProcessor::OnSetEnabled() method, this method is empty and can be overwritten. More...
 

Detailed Description

A helper class for simple use of the IProcessor object.

The BaseProcessor class implements the IAppProcessor app interface.
A processor is created and initialized at object instantiation.

Constructor & Destructor Documentation

◆ BaseProcessor()

Murl::Logic::BaseProcessor::BaseProcessor ( IFactory factory)
inline

The constructor.

Creates a IProcessor object and setup the processor app interface.

Parameters
factoryThe logic factory object.

◆ ~BaseProcessor()

Murl::Logic::BaseProcessor::~BaseProcessor ( )
inlineoverride

The destructor.

Destroys the IProcessor object.

Member Function Documentation

◆ operator IProcessorPtr()

Murl::Logic::BaseProcessor::operator IProcessorPtr ( ) const
inline

Conversion operator.

Returns
The IProcessor interface.

◆ GetProcessor()

IProcessorPtr Murl::Logic::BaseProcessor::GetProcessor ( ) const
inline

Get the processor interface.

Returns
The IProcessor interface.

◆ SetAppProcessor()

Bool Murl::Logic::BaseProcessor::SetAppProcessor ( IAppProcessorPtr  appProcessor) const
inline

Forward to IProcessor::SetAppProcessor() method.

Parameters
appProcessorThe processor callback object.
Returns
true if successful.

◆ IsInitialized()

Bool Murl::Logic::BaseProcessor::IsInitialized ( ) const
inline

Forward to IProcessor::IsInitialized() method.

Returns
true if the processor is initialized.

◆ SetEnabled()

void Murl::Logic::BaseProcessor::SetEnabled ( Bool  isEnabled) const
inline

Forward to IProcessor::SetEnabled() method.

Parameters
isEnabledtrue for enable, false for disable.

◆ IsEnabled()

Bool Murl::Logic::BaseProcessor::IsEnabled ( ) const
inline

Forward to IProcessor::IsEnabled() method.

Returns
true if enabled.

◆ AddChild()

Bool Murl::Logic::BaseProcessor::AddChild ( IProcessorPtr  processor) const
inline

Forward to IProcessor::AddChild() method.

Parameters
processorThe processor object to add.
Returns
true if successful.

◆ RemoveChild()

Bool Murl::Logic::BaseProcessor::RemoveChild ( IProcessorPtr  processor) const
inline

Forward to IProcessor::RemoveChild() method.

Parameters
processorThe processor object to remove.
Returns
true if successful.

◆ InitAddChild()

Bool Murl::Logic::BaseProcessor::InitAddChild ( const IState state,
IProcessorPtr  processor 
) const
inline

Forward to IProcessor::InitAddChild() method.

Parameters
stateThe IState object.
processorThe processor object to initialize and add.
Returns
true if successful.

◆ RemoveDeInitChild()

Bool Murl::Logic::BaseProcessor::RemoveDeInitChild ( const IState state,
IProcessorPtr  processor 
) const
inline

Forward to IProcessor::RemoveDeInitChild() method.

Parameters
stateThe IState object.
processorThe processor object to remove and deinitialize.
Returns
true if successful.

◆ GetNumberOfChildren()

UInt32 Murl::Logic::BaseProcessor::GetNumberOfChildren ( ) const
inline

Forward to IProcessor::GetNumberOfChildren() method.

Returns
The number of children.

◆ GetChild()

IProcessorPtr Murl::Logic::BaseProcessor::GetChild ( UInt32  index) const
inline

Forward to IProcessor::GetChild() method.

Parameters
indexThe zero-based index of the child processor.
Returns
The child processor object or null if the index is out of range.

◆ AddStepable()

Bool Murl::Logic::BaseProcessor::AddStepable ( IStepablePtr  stepable) const
inline

Forward to IProcessor::AddStepable() method.

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

◆ RemoveStepable()

Bool Murl::Logic::BaseProcessor::RemoveStepable ( IStepablePtr  stepable) const
inline

Forward to IProcessor::RemoveStepable() method.

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

◆ GetStepableObserver()

Logic::IStepableObserverPtr Murl::Logic::BaseProcessor::GetStepableObserver ( ) const
inline

Forward to IProcessor::GetStepableObserver() method.

Returns
The processor's IStepableObserver object.

◆ AddGraphNode()

Bool Murl::Logic::BaseProcessor::AddGraphNode ( IObservableNodePtr  observableNode) const
inline

Forward to IProcessor::AddGraphNode() method.

Parameters
observableNodeThe observable node object to add.
Returns
true if successful.

◆ RemoveGraphNode()

Bool Murl::Logic::BaseProcessor::RemoveGraphNode ( IObservableNodePtr  observableNode) const
inline

Forward to IProcessor::RemoveGraphNode() method.

Parameters
observableNodeThe observable node object to remove.
Returns
true if successful.

◆ AreGraphNodesValid()

Bool Murl::Logic::BaseProcessor::AreGraphNodesValid ( ) const
inline

Forward to IProcessor::AreGraphNodesValid() method.

Returns
true if all observed nodes are valid.

◆ GetNodeObserverPtr()

INodeObserverPtr Murl::Logic::BaseProcessor::GetNodeObserverPtr ( ) const
inline

Forward to IProcessor::GetNodeObserver() method.

Returns
The processor's INodeObserver object.

◆ GetNodeObserver()

INodeObserver* Murl::Logic::BaseProcessor::GetNodeObserver ( ) const
inline

Get the processor's node observer interface pointer.

Returns
The processor's INodeObserver interface pointer.

References Murl::SharedPointer< DataType >::Get().

◆ OnInit()

Bool Murl::Logic::BaseProcessor::OnInit ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
Returns
true if successful, should return false if any initialization failed.

Implements Murl::Logic::IAppProcessor.

◆ OnDeInit()

Bool Murl::Logic::BaseProcessor::OnDeInit ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
Returns
true if successful, should return false if any deinitialization failed.

Implements Murl::Logic::IAppProcessor.

◆ OnProcessTick()

void Murl::Logic::BaseProcessor::OnProcessTick ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnProcessTickChildren()

void Murl::Logic::BaseProcessor::OnProcessTickChildren ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnProcessFrame()

void Murl::Logic::BaseProcessor::OnProcessFrame ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnProcessFrameChildren()

void Murl::Logic::BaseProcessor::OnProcessFrameChildren ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnFinishTick()

void Murl::Logic::BaseProcessor::OnFinishTick ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnFinishTickChildren()

void Murl::Logic::BaseProcessor::OnFinishTickChildren ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnFinishFrame()

void Murl::Logic::BaseProcessor::OnFinishFrame ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnFinishFrameChildren()

void Murl::Logic::BaseProcessor::OnFinishFrameChildren ( const Logic::IState state)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.

Implements Murl::Logic::IAppProcessor.

◆ OnPackageWillBeLoaded()

void Murl::Logic::BaseProcessor::OnPackageWillBeLoaded ( const Logic::IState state,
IPackage package 
)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
packageThe package to load.

Implements Murl::Logic::IAppProcessor.

◆ OnPackageWasLoaded()

void Murl::Logic::BaseProcessor::OnPackageWasLoaded ( const Logic::IState state,
IPackage package 
)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
packageThe package to load.

Implements Murl::Logic::IAppProcessor.

◆ OnPackageFailedLoading()

void Murl::Logic::BaseProcessor::OnPackageFailedLoading ( const Logic::IState state,
IPackage package 
)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
packageThe package to load.

Implements Murl::Logic::IAppProcessor.

◆ OnPackageWillBeUnloaded()

void Murl::Logic::BaseProcessor::OnPackageWillBeUnloaded ( const Logic::IState state,
IPackage package 
)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
packageThe package to load.

Implements Murl::Logic::IAppProcessor.

◆ OnPackageWasUnloaded()

void Murl::Logic::BaseProcessor::OnPackageWasUnloaded ( const Logic::IState state,
IPackage package 
)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
packageThe package to load.

Implements Murl::Logic::IAppProcessor.

◆ OnPackageFailedUnloading()

void Murl::Logic::BaseProcessor::OnPackageFailedUnloading ( const Logic::IState state,
IPackage package 
)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
packageThe package to load.

Implements Murl::Logic::IAppProcessor.

◆ OnRunStateChanged()

void Murl::Logic::BaseProcessor::OnRunStateChanged ( const Logic::IState state,
IEnums::AppRunState  currentState,
IEnums::AppRunState  previousState 
)
inlineoverrideprotectedvirtual

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

Parameters
stateThe IState object.
currentStateThe current run state.
previousStateThe previous run state.

Implements Murl::Logic::IAppProcessor.

◆ OnSetEnabled()

void Murl::Logic::BaseProcessor::OnSetEnabled ( Bool  isEnabled)
inlineoverrideprotectedvirtual

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

Parameters
isEnabledtrue if enabled.

Implements Murl::Logic::IAppProcessor.


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


Copyright © 2011-2022 Spraylight GmbH.