Murl::Logic::BaseNodeObserver Class Reference

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

#include "murl_logic_base_node_observer.h"

Inheritance diagram for Murl::Logic::BaseNodeObserver:

Public Member Functions
	BaseNodeObserver ()
	The default constructor. More...
virtual	~BaseNodeObserver ()
	The destructor. More...
	operator INodeObserver * () const
	Conversion operator. More...
	operator INodeObserverPtr () const
	Conversion operator. More...
INodeObserverPtr	GetNodeObserver () const
	Get the node observer interface. More...
Bool	Add (IObservableNodePtr node) const
	Forward to INodeObserver::Add() method. More...
Bool	Remove (IObservableNodePtr node) const
	Forward to INodeObserver::Remove() method. More...
Bool	RemoveAt (UInt32 index) const
	Forward to INodeObserver::RemoveAt() method. More...
UInt32	GetNumberOfNodes () const
	Forward to INodeObserver::GetNumberOfNodes() method. More...
IObservableNodePtr	GetNode (UInt32 index) const
	Forward to INodeObserver::GetNode() method. More...
IObservableNodePtr	GetNodeIfValid (UInt32 index) const
	Forward to INodeObserver::GetNodeIfValid() method. More...
Bool	AreValid () const
	Forward to INodeObserver::AreValid() method. More...
Bool	RemoveAll () const
	Forward to INodeObserver::RemoveAll() method. More...
Public Member Functions inherited from Murl::NonCopyable
	NonCopyable ()=default
	The default constructor.

Detailed Description

A helper class for simple use of the INodeObserver object.

A node observer is created and initialized at object instantiation.

Constructor & Destructor Documentation

BaseNodeObserver()

Murl::Logic::BaseNodeObserver::BaseNodeObserver ( )

inline

The default constructor.

Creates a INodeObserver object.

~BaseNodeObserver()

virtual Murl::Logic::BaseNodeObserver::~BaseNodeObserver ( )

inlinevirtual

The destructor.

Destroys the INodeObserver object.

Member Function Documentation

operator INodeObserver *()

Murl::Logic::BaseNodeObserver::operator INodeObserver * ( ) const

inline

Conversion operator.

Returns

The INodeObserver interface.

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

operator INodeObserverPtr()

Murl::Logic::BaseNodeObserver::operator INodeObserverPtr ( ) const

inline

Conversion operator.

Returns

The INodeObserver interface.

GetNodeObserver()

INodeObserverPtr Murl::Logic::BaseNodeObserver::GetNodeObserver ( ) const

inline

Get the node observer interface.

Returns

The INodeObserver interface.

Add()

Bool Murl::Logic::BaseNodeObserver::Add ( IObservableNodePtr  node ) const

inline

Forward to INodeObserver::Add() method.

Parameters

node	The observable node object to add.

Returns

true if successful.

Remove()

Bool Murl::Logic::BaseNodeObserver::Remove ( IObservableNodePtr  node ) const

inline

Forward to INodeObserver::Remove() method.

Parameters

node	The observable node object to remove.

Returns

true if successful.

RemoveAt()

Bool Murl::Logic::BaseNodeObserver::RemoveAt ( UInt32  index ) const

inline

Forward to INodeObserver::RemoveAt() method.

Parameters

index

The zero based index of the observable node object to remove.

Returns

true if successful.

GetNumberOfNodes()

UInt32 Murl::Logic::BaseNodeObserver::GetNumberOfNodes ( ) const

inline

Forward to INodeObserver::GetNumberOfNodes() method.

Returns

The number of observable node objects.

GetNode()

IObservableNodePtr Murl::Logic::BaseNodeObserver::GetNode ( UInt32  index ) const

inline

Forward to INodeObserver::GetNode() method.

Parameters

index

The zero based index of the observable node object.

Returns

The observable node object or null if the index is out of range.

GetNodeIfValid()

IObservableNodePtr Murl::Logic::BaseNodeObserver::GetNodeIfValid ( UInt32  index ) const

inline

Forward to INodeObserver::GetNodeIfValid() method.

Parameters

index

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

Bool Murl::Logic::BaseNodeObserver::AreValid ( ) const

inline

Forward to INodeObserver::AreValid() method.

Returns

true if all observed nodes are valid.

RemoveAll()

Bool Murl::Logic::BaseNodeObserver::RemoveAll ( ) const

inline

Forward to INodeObserver::RemoveAll() method.

Returns

true if successful.

---

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

• murl_logic_base_node_observer.h