BOL::PushingObserved< PushedClass > Class Template Reference

#include <PushingObserved.hpp>

Inheritance diagram for BOL::PushingObserved< PushedClass >:

Detailed Description

template<typename PushedClass>
class BOL::PushingObserved< PushedClass >

Definition at line 26 of file PushingObserved.hpp.

Public Member Functions
	PushingObserved ()
virtual void	registerObserver (PushedToObserver< PushedClass > *const joiningObserver)
void	removeAllObservers ()
virtual void	removeObserver (PushedToObserver< PushedClass > *const leavingObserver)
virtual void	updateObservers ()
virtual void	updateObservers (PushedClass const &pushedValue)
virtual	~PushingObserved ()

Protected Types
typedef std::pair< PushedToObserver< PushedClass > *, bool >	observerWithBool
typedef std::list< observerWithBool >::iterator	observerWithBoolListIterator

Protected Attributes
observerWithBoolListIterator	observerIterator
std::list< observerWithBool >	observerList

Member Typedef Documentation

observerWithBool

template<typename PushedClass >

typedef std::pair< PushedToObserver< PushedClass >*, bool > BOL::PushingObserved< PushedClass >::observerWithBool

protected

Definition at line 61 of file PushingObserved.hpp.

observerWithBoolListIterator

template<typename PushedClass >

typedef std::list<observerWithBool>::iterator BOL::PushingObserved< PushedClass >::observerWithBoolListIterator

protected

Definition at line 63 of file PushingObserved.hpp.

Constructor & Destructor Documentation

PushingObserved()

template<typename PushedClass >

BOL::PushingObserved< PushedClass >::PushingObserved

inline

Definition at line 74 of file PushingObserved.hpp.

                                                  :
      observerList(),
      observerIterator()
  {
    // just an initialization list.
  }

~PushingObserved()

template<typename PushedClass >

BOL::PushingObserved< PushedClass >::~PushingObserved

inlinevirtual

Definition at line 83 of file PushingObserved.hpp.

  {
    removeAllObservers();
  }

Member Function Documentation

registerObserver()

template<typename PushedClass >

void BOL::PushingObserved< PushedClass >::registerObserver ( PushedToObserver< PushedClass > *const  joiningObserver )

inlinevirtual

Definition at line 138 of file PushingObserved.hpp.

  {
    observerList.push_back( observerWithBool( joiningObserver,
                                              true ) );
    joiningObserver->acceptFlagFromObserved( &(observerList.back().second) );
    /* new observers are given a pointer to their associated bools, which
     * indicate that their observers should be fine for
     * respondToPush( ... ) calls if the bool is true, but if the bool is
     * false, this PushingObserved instance knows to remove the observer with
     * its next pass through the list.
     */
  }

removeAllObservers()

template<typename PushedClass >

void BOL::PushingObserved< PushedClass >::removeAllObservers

inline

Definition at line 179 of file PushingObserved.hpp.

  {
    observerIterator = observerList.begin();
    while( observerList.end() != observerIterator )
    {
      if( observerIterator->second )
      {
        observerIterator->first->discardFlagFromObserved(
                                                 &(observerIterator->second) );
      }
      ++observerIterator;
    }
    observerList.clear();
  }

removeObserver()

template<typename PushedClass >

void BOL::PushingObserved< PushedClass >::removeObserver ( PushedToObserver< PushedClass > *const  leavingObserver )

inlinevirtual

Definition at line 154 of file PushingObserved.hpp.

  {
    observerIterator = observerList.begin();
    while( observerList.end() != observerIterator )
    {
      if( !(observerIterator->second) )
      {
        observerIterator = observerList.erase( observerIterator );
      }
      else if( leavingObserver == observerIterator->first )
      {
        leavingObserver->discardFlagFromObserved(
                                                 &(observerIterator->second) );
        observerIterator = observerList.erase( observerIterator );
      }
      else
      {
        ++observerIterator;
      }
    }
  }

updateObservers() [1/2]

template<typename PushedClass >

void BOL::PushingObserved< PushedClass >::updateObservers

inlinevirtual

Definition at line 115 of file PushingObserved.hpp.

  {
    observerIterator = observerList.begin();
    while( observerList.end() != observerIterator )
    {
      if( observerIterator->second )
      {
        observerIterator->first->respondToObservedSignal();
        ++observerIterator;
      }
      else
      {
        observerIterator = observerList.erase( observerIterator );
      }
    }
  }

updateObservers() [2/2]

template<typename PushedClass >

void BOL::PushingObserved< PushedClass >::updateObservers ( PushedClass const &  pushedValue )

inlinevirtual

Definition at line 91 of file PushingObserved.hpp.

  {
    observerIterator = observerList.begin();
    while( observerList.end() != observerIterator )
    {
      if( observerIterator->second )
      {
        observerIterator->first->respondToPush( pushedValue );
        ++observerIterator;
      }
      else
      {
        observerIterator = observerList.erase( observerIterator );
      }
    }
  }

Member Data Documentation

observerIterator

template<typename PushedClass >

observerWithBoolListIterator BOL::PushingObserved< PushedClass >::observerIterator

protected

Definition at line 65 of file PushingObserved.hpp.

observerList

template<typename PushedClass >

std::list< observerWithBool > BOL::PushingObserved< PushedClass >::observerList

protected

Definition at line 64 of file PushingObserved.hpp.

---

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

• PushingObserved.hpp