ossimListenerManager Class Reference

#include <ossimListenerManager.h>

Inheritance diagram for ossimListenerManager:

Public Member Functions
	ossimListenerManager ()
virtual	~ossimListenerManager ()
virtual void	fireEvent (ossimEvent &event)
virtual bool	addListener (ossimListener *listener)
virtual bool	removeListener (ossimListener *listener)
virtual bool	findListener (ossimListener *listener)

Protected Member Functions
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes
std::list< ossimListener * >	theListenerList
bool	theEnabledFlag
std::list< ossimListener * >	theDelayedAdd
std::list< ossimListener * >	theDelayedRemove
bool	theFireEventFlag

Detailed Description

Definition at line 20 of file ossimListenerManager.h.

Constructor & Destructor Documentation

ossimListenerManager() [1/2]

ossimListenerManager::ossimListenerManager

(

)

Default constructor and needs no initialization.

Definition at line 20 of file ossimListenerManager.cpp.

References theFireEventFlag.

{
   theFireEventFlag = false;
}

~ossimListenerManager()

ossimListenerManager::~ossimListenerManager ( )

virtual

Default destructor. Note the Manager doesn't own the listeners and will not delete them

Definition at line 30 of file ossimListenerManager.cpp.

References theListenerList.

{
   theListenerList.clear();
}

ossimListenerManager() [2/2]

ossimListenerManager::ossimListenerManager ( const ossimListenerManager &  rhs )

protected

Will search the list and return the index if found else returns a negative value.

Definition at line 25 of file ossimListenerManager.cpp.

{
//    replaceListeners(rhs.getListeners());
}

Member Function Documentation

addListener()

bool ossimListenerManager::addListener ( ossimListener *  listener )

virtual

Appends the listener onto the list.

Reimplemented in ossimImageFileWriter.

Definition at line 98 of file ossimListenerManager.cpp.

References findListener(), theDelayedAdd, theFireEventFlag, and theListenerList.

Referenced by ossimImageChain::add(), ossimImageChain::addLast(), ossimImageFileWriter::addListener(), ATP::AtpTileSource::AtpTileSource(), ossimImageHandler::buildHistogram(), ossimHistogramWriter::connectInputEvent(), ossimVerticesFinderTool::execute(), fireEvent(), ossimImageChain::insertLeft(), ossimImageChain::insertRight(), ossimImageChain::ossimImageChain(), ossimImageCombiner::ossimImageCombiner(), ossimImageHistogramSource::ossimImageHistogramSource(), ossimImageSourceFilter::ossimImageSourceFilter(), ossimImageSourceSequencer::ossimImageSourceSequencer(), ossimMetadataFileWriter::ossimMetadataFileWriter(), ossimImageChain::removeChild(), ossimImageChain::replace(), ossimHistogramWriter::writeHistogram(), ossimImageFileWriter::writeHistogramFile(), and ossimImageFileWriter::writeOverviewFile().

{
   if(theFireEventFlag)
   {
      theDelayedAdd.push_back(listener);
   }
   else
   {
      
      if(!findListener(listener))
      {
         theListenerList.push_back(listener);
      }
   }
   
   return true;
}

findListener()

bool ossimListenerManager::findListener ( ossimListener *  listener )

virtual

Will find the listener passed in as the first argument and insert the passed in listener before it. If not found then it will default to a push to front.

Will find the listener passed in as the first argument and insert the passed in listener after it. If not found then it will default to an append.

Will insert the listener before the specified listener. If the index is invalid it defaults to a push to front. An invalid index is any index < 0 or larger than the number of items currently in the list.

Will insert the listener after the specified listener. If the index is invalid it defaults to an addListener. An invalid index is any index < 0 or larger than the number of items currently in the list.

Searches the list and sees if a listener is found

Definition at line 142 of file ossimListenerManager.cpp.

References theListenerList.

Referenced by addListener().

{
   bool result = false;

   if(listener)
   {
      std::list<ossimListener*>::iterator currentIter =
         std::find(theListenerList.begin(),
                   theListenerList.end(),
                   listener);
      result = (currentIter != theListenerList.end());
   }
   
   return result;
}

fireEvent()

void ossimListenerManager::fireEvent ( ossimEvent &  event )

virtual

Traverses through all listeners and fires an event to them. if any listener sets the consumed flag on the event it will stop traversing the list.

Definition at line 35 of file ossimListenerManager.cpp.

References addListener(), ossimEvent::isConsumed(), removeListener(), theDelayedAdd, theDelayedRemove, theFireEventFlag, and theListenerList.

Referenced by ossimImageChain::add(), ossimImageChain::addLast(), ossimConnectableObject::connectInputList(), ossimConnectableObject::connectMyInputTo(), ossimConnectableObject::connectMyOutputTo(), ossimConnectableObject::connectOutputList(), ossimImageChain::deleteFirst(), ossimImageChain::deleteLast(), ossimImageChain::deleteList(), ossimConnectableObject::disconnectAllInputs(), ossimConnectableObject::disconnectAllOutputs(), ossimConnectableObject::disconnectMyInput(), ossimConnectableObject::disconnectMyInputs(), ossimConnectableObject::disconnectMyOutput(), ossimConnectableObject::disconnectMyOutputs(), ossimCacheTileSource::fireProgressEvent(), ossimImageChain::insertLeft(), ossimImageChain::insertRight(), ossimConnectableObject::moveInputDown(), ossimConnectableObject::moveInputToBottom(), ossimConnectableObject::moveInputToTop(), ossimConnectableObject::moveInputUp(), ossimHistogramWriterProcessListener::processProgressEvent(), ossimConnectableObject::propagateEventToInputs(), ossimConnectableObject::propagateEventToOutputs(), ossimImageChain::removeChild(), ossimProcessInterface::setCurrentMessage(), ossimProcessInterface::setPercentComplete(), ossimMetadataFileWriter::setPercentComplete(), ossimVertexExtractor::setPercentComplete(), ossimImageFileWriter::setPercentComplete(), and ossimEventVisitor::visit().

{
   // only process the event if it has not been consumed.
   event.setCurrentObject( dynamic_cast<ossimObject*>(this) );
   if(event.isConsumed())
   {
      return;
   }
   theFireEventFlag = true;

   std::list<ossimListener*>::iterator currentIterator = theListenerList.begin();
   
   while(currentIterator != theListenerList.end())
   {
      // only fire if the event is not consumed
      if(!event.isConsumed())
      {
         if(*currentIterator)
         {
            if(theDelayedRemove.end()==std::find(theDelayedRemove.begin(),
                                                 theDelayedRemove.end(),
                                                 (*currentIterator)))
            {
               if((*currentIterator)->isListenerEnabled())
               {
                  (*currentIterator)->processEvent(event);
               }
            }
         }
      }
      else
      {
         // the event is now consumed so stop propagating.
         //
         theFireEventFlag = false;
         break;
      }
      ++currentIterator;
   }
   
   theFireEventFlag = false;
   
   if(theDelayedAdd.size())
   {
      for(std::list<ossimListener*>::iterator current = theDelayedAdd.begin();
          current != theDelayedAdd.end();++current)
      {
         addListener(*current);
      }
      theDelayedAdd.clear();
   }
   
   if(theDelayedRemove.size())
   {
      for(std::list<ossimListener*>::iterator current = theDelayedRemove.begin();
          current != theDelayedRemove.end();++current)
      {
         removeListener(*current);
      }
      theDelayedRemove.clear();
   }
}

removeListener()

bool ossimListenerManager::removeListener ( ossimListener *  listener )

virtual

Will push the lister to the front of the list.

Finds and removes the listener.

Reimplemented in ossimImageFileWriter.

Definition at line 116 of file ossimListenerManager.cpp.

References theDelayedRemove, theFireEventFlag, and theListenerList.

Referenced by ossimImageHandlerMtAdaptor::close(), ossimConnectableContainer::deleteAllChildren(), fireEvent(), ossimImageChain::prepareForRemoval(), ossimConnectableContainer::removeAllListeners(), ossimConnectableContainer::removeChild(), ossimImageFileWriter::removeListener(), ossimImageChain::replace(), ossimImageFileWriter::writeOverviewFile(), ossimImageChain::~ossimImageChain(), ossimImageChainMtAdaptor::~ossimImageChainMtAdaptor(), ossimImageCombiner::~ossimImageCombiner(), ossimImageHistogramSource::~ossimImageHistogramSource(), ossimImageSourceFilter::~ossimImageSourceFilter(), ossimImageSourceSequencer::~ossimImageSourceSequencer(), and ossimMetadataFileWriter::~ossimMetadataFileWriter().

{
   
   if(theFireEventFlag)
   {
      theDelayedRemove.push_back(listener);
      return true;
   }
   
   std::list<ossimListener*>::iterator current=theListenerList.begin();
   while(current!=theListenerList.end())
   {
      if( (*current) == listener)
      {
         current = theListenerList.erase(current);
         break; // Should only be in list once... (drb)
      }
      else
      {
         ++current;
      }
   }
   
   return true;
}

Member Data Documentation

theDelayedAdd

std::list<ossimListener*> ossimListenerManager::theDelayedAdd

mutableprotected

Definition at line 115 of file ossimListenerManager.h.

Referenced by addListener(), and fireEvent().

theDelayedRemove

std::list<ossimListener*> ossimListenerManager::theDelayedRemove

mutableprotected

Definition at line 116 of file ossimListenerManager.h.

Referenced by fireEvent(), and removeListener().

theEnabledFlag

bool ossimListenerManager::theEnabledFlag

protected

Definition at line 114 of file ossimListenerManager.h.

theFireEventFlag

bool ossimListenerManager::theFireEventFlag

mutableprotected

Definition at line 117 of file ossimListenerManager.h.

Referenced by addListener(), fireEvent(), ossimListenerManager(), and removeListener().

theListenerList

std::list<ossimListener*> ossimListenerManager::theListenerList

protected

Holds the list of listeners.

Definition at line 113 of file ossimListenerManager.h.

Referenced by addListener(), findListener(), fireEvent(), removeListener(), and ~ossimListenerManager().

---

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

• ossimListenerManager.h
• ossimListenerManager.cpp