Murl::Logic::GraphReplication Class Referenceabstract

Base class for a single replication required by Logic::GraphInstanceObjects. More...

#include "murl_logic_graph_replication.h"

Inheritance diagram for Murl::Logic::GraphReplication:

Public Member Functions

virtual Bool Init (INodeObserver *nodeObserver, const Graph::IRoot *root, const String &replicationIdPath, SInt32 index)
 Initialize the object. More...
 
virtual Bool Init (INodeObserver *nodeObserver, Graph::INode *replicationNode, SInt32 index)=0
 Initialize the object. More...
 
virtual Bool DeInit ()=0
 Deinitialize the object. More...
 
virtual void SetObtained (Bool isObtained)=0
 Set the obtained state. More...
 
- Public Member Functions inherited from Murl::Logic::BaseStepable
 BaseStepable ()
 The default constructor. More...
 
virtual ~BaseStepable ()
 The destructor. More...
 
 operator IStepablePtr ()
 Conversion operator. More...
 
- Public Member Functions inherited from Murl::Logic::Stepable
virtual ~Stepable ()
 The destructor.
 
virtual Bool SetAppStepable (IAppStepablePtr appStepable)
 Implementation of IStepable::SetAppStepable() method.
 
virtual void SetEnabled (Bool isEnabled)
 Implementation of IStepable::SetEnabled() method.
 
virtual Bool IsEnabled () const
 Implementation of IStepable::IsEnabled() method.
 
virtual void Reset ()
 Implementation of IStepable::Reset() method.
 
virtual void ProcessTick (const Logic::IState *state)
 Implementation of IStepable::ProcessTick() method.
 
virtual void FinishTick (const Logic::IState *state)
 Implementation of IStepable::FinishTick() method.
 

Additional Inherited Members

- Static Public Member Functions inherited from Murl::Logic::Stepable
static IStepablePtr Create ()
 Create a stepable object. More...
 
- Protected Member Functions inherited from Murl::Logic::BaseStepable
virtual void OnSetEnabled (Bool isEnabled)
 Default implementation of IAppStepable::OnSetEnabled() method, this method is empty and can be overwritten.
 
virtual void OnReset ()
 Default implementation of IAppStepable::OnReset() method, this method is empty and can be overwritten.
 
virtual void OnProcessTick (const Logic::IState *state)
 Default implementation of IAppStepable::OnProcessTick() method, this method is empty and can be overwritten.
 
virtual void OnFinishTick (const Logic::IState *state)
 Default implementation of IAppStepable::OnFinishTick() method, this method is empty and can be overwritten.
 

Detailed Description

Base class for a single replication required by Logic::GraphInstanceObjects.

Member Function Documentation

◆ Init() [1/2]

virtual Bool Murl::Logic::GraphReplication::Init ( INodeObserver nodeObserver,
const Graph::IRoot root,
const String replicationIdPath,
SInt32  index 
)
inlinevirtual

Initialize the object.

Parameters
nodeObserverThe INodeObserver object.
rootThe graph root node.
replicationIdPathThe full path to the replication's graph node.
indexThe index of the replication.
Returns
true if successful.

Reimplemented in Murl::Logic::GraphPositionInstance, and Murl::Logic::GraphSoundInstance.

References DeInit(), Murl::Graph::IRoot::FindNode(), and SetObtained().

◆ Init() [2/2]

virtual Bool Murl::Logic::GraphReplication::Init ( INodeObserver nodeObserver,
Graph::INode replicationNode,
SInt32  index 
)
pure virtual

Initialize the object.

Parameters
nodeObserverThe INodeObserver object.
replicationNodeThe replication's graph node.
indexThe index of the replication.
Returns
true if successful.

Implemented in Murl::Logic::GraphPositionInstance, and Murl::Logic::GraphSoundInstance.

◆ DeInit()

virtual Bool Murl::Logic::GraphReplication::DeInit ( )
pure virtual

Deinitialize the object.

Returns
true if successful.

Implemented in Murl::Logic::GraphPositionInstance, and Murl::Logic::GraphSoundInstance.

Referenced by Init().

◆ SetObtained()

virtual void Murl::Logic::GraphReplication::SetObtained ( Bool  isObtained)
pure virtual

Set the obtained state.

Parameters
isObtainedThe obtained state.

Implemented in Murl::Logic::GraphPositionInstance, and Murl::Logic::GraphSoundInstance.

Referenced by Init().


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


Copyright © 2011-2018 Spraylight GmbH.