Murl::Logic::INodeObserver Interface Referenceabstract

The INodeObserver interface. More...

#include "murl_logic_i_node_observer.h"

Inherited by Murl::Logic::NodeObserver.

Public Member Functions

virtual Bool Add (IObservableNodePtr node)=0
 Add a observable node object to the observer. More...
 
virtual Bool Remove (IObservableNodePtr node)=0
 Remove a observable node object from the observer. More...
 
virtual Bool RemoveAt (UInt32 index)=0
 Remove a observable node object by index from the observer. More...
 
virtual UInt32 GetNumberOfNodes () const =0
 Get the number of observable node objects in the observer. More...
 
virtual IObservableNodePtr GetNode (UInt32 index) const =0
 Get a observable node object by index. More...
 
virtual IObservableNodePtr GetNodeIfValid (UInt32 index) const =0
 Get a valid observable node object by index. More...
 
virtual Bool AreValid () const =0
 Check all observed nodes. More...
 
virtual Bool RemoveAll ()=0
 Remove all observed nodes from the observer. More...
 

Detailed Description

The INodeObserver interface.

The node observer notifies objects implementing the IObservableNode interface.
The IProcessor object provides a ready to use node observer.

Member Function Documentation

◆ Add()

virtual Bool Murl::Logic::INodeObserver::Add ( IObservableNodePtr  node)
pure virtual

Add a observable node object to the observer.

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

Referenced by Murl::Logic::GraphPositionObject::Init(), Murl::Logic::GraphSoundObject::Init(), Murl::Logic::GraphSoundInstance::Init(), and Murl::Logic::GraphPositionInstance::Init().

◆ Remove()

virtual Bool Murl::Logic::INodeObserver::Remove ( IObservableNodePtr  node)
pure virtual

Remove a observable node object from the observer.

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

◆ RemoveAt()

virtual Bool Murl::Logic::INodeObserver::RemoveAt ( UInt32  index)
pure virtual

Remove a observable node object by index from the observer.

A valid index is [0 .. GetNumberOfNodes() - 1].

Parameters
indexThe zero based index of the observable node object to remove.
Returns
true if successful.

◆ GetNumberOfNodes()

virtual UInt32 Murl::Logic::INodeObserver::GetNumberOfNodes ( ) const
pure virtual

Get the number of observable node objects in the observer.

Returns
The number of observable node objects.

◆ GetNode()

virtual IObservableNodePtr Murl::Logic::INodeObserver::GetNode ( UInt32  index) const
pure virtual

Get a observable node object by index.

A valid index is [0 .. GetNumberOfNodes() - 1].

Parameters
indexThe zero based index of the observable node object.
Returns
The observable node object or null if the index is out of range.

◆ GetNodeIfValid()

virtual IObservableNodePtr Murl::Logic::INodeObserver::GetNodeIfValid ( UInt32  index) const
pure virtual

Get a valid observable node object by index.

Check the observable node at index using IObservableNode::IsValid(). A valid index is [0 .. GetNumberOfNodes() - 1].

Parameters
indexThe zero based index of the observable node object.
Returns
The observable node object or null if the node object is invalid or the index is out of range.

◆ AreValid()

virtual Bool Murl::Logic::INodeObserver::AreValid ( ) const
pure virtual

Check all observed nodes.

Returns
true if all observed nodes are valid.

◆ RemoveAll()

virtual Bool Murl::Logic::INodeObserver::RemoveAll ( )
pure virtual

Remove all observed nodes from the observer.

Returns
true if successful.

The documentation for this interface was generated from the following file:
  • murl_logic_i_node_observer.h


Copyright © 2011-2018 Spraylight GmbH.