BOL::BasicObserved Class Reference

#include <BasicObserved.hpp>

Detailed Description

Definition at line 23 of file BasicObserved.hpp.

Public Member Functions
	BasicObserved ()
void	registerObserver (BasicObserver *const joiningObserver)
void	removeAllObservers ()
void	removeObserver (BasicObserver *const leavingObserver)
void	updateObservers ()
virtual	~BasicObserved ()

Protected Attributes
std::list< std::pair< BasicObserver *, bool > >::iterator	observerIterator
std::list< std::pair< BasicObserver *, bool > >	observerList

Constructor & Destructor Documentation

BasicObserved()

BOL::BasicObserved::BasicObserved

(

)

Definition at line 17 of file BasicObserved.cpp.

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

~BasicObserved()

BOL::BasicObserved::~BasicObserved ( )

virtual

Definition at line 24 of file BasicObserved.cpp.

  {
    removeAllObservers();
  }

Member Function Documentation

registerObserver()

void BOL::BasicObserved::registerObserver ( BasicObserver *const  joiningObserver )

inline

Definition at line 82 of file BasicObserved.hpp.

  {
    observerList.push_back( std::pair< BasicObserver*, bool >( 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
     * respondToObservedSignal() calls if the bool is true, but if the bool is
     * false, this BasicObserved instance knows to remove the observer with
     * its next pass through the list.
     */
  }

removeAllObservers()

void BOL::BasicObserved::removeAllObservers ( )

inline

Definition at line 123 of file BasicObserved.hpp.

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

removeObserver()

void BOL::BasicObserved::removeObserver ( BasicObserver *const  leavingObserver )

inline

Definition at line 96 of file BasicObserved.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()

void BOL::BasicObserved::updateObservers ( )

inline

Definition at line 60 of file BasicObserved.hpp.

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

Member Data Documentation

observerIterator

std::list<std::pair<BasicObserver*,bool>>::iterator BOL::BasicObserved::observerIterator

protected

Definition at line 52 of file BasicObserved.hpp.

observerList

std::list< std::pair< BasicObserver*, bool > > BOL::BasicObserved::observerList

protected

Definition at line 51 of file BasicObserved.hpp.

---

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

• BasicObserved.hpp
• BasicObserved.cpp