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

Protected Member Functions

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

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()

virtual Murl::Logic::BaseProcessor::~BaseProcessor ( )
inlinevirtual

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.

◆ 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().


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


Copyright © 2011-2018 Spraylight GmbH.