CompletionTrans.h

Go to the documentation of this file.

//-*-c++-*-
#ifndef INCLUDED_CompletionTrans_h_
#define INCLUDED_CompletionTrans_h_

#include "Behaviors/StateNode.h"
#include "Behaviors/Transition.h"
#include "Events/EventRouter.h"

//! causes a transition when at least @e n sources have signalled completion;  @e n = 0 means "all" (default)
class CompletionTrans : public Transition {
protected:
  int minsrcs; //!< the minimum number of sources which must signal completion before this transition will fire
  bool *completions;  //!< pointer to array for recording completion events for all sources
  EventBase savedEvent; //!< Copy of current event to be used after timer expires
  
public:
  //! constructor, pass @a destination and the minimum number of sources which must signal completion before this transition will fire
  CompletionTrans(StateNode* destination, int n=0) :
    Transition(destination), minsrcs(n), completions(NULL), savedEvent() {};
  
  //! constructor, pass @a name, @a destination and the minimum number of times the source must signal completion beyond the first (@a n)
  CompletionTrans(const std::string& name, StateNode* destination, int n=0) :
    Transition(name,destination), minsrcs(n), completions(NULL), savedEvent() {};
  
  //! starts listening
  virtual void postStart() {
    Transition::postStart();
    unsigned int const numsrcs = getSources().size();
    completions = new bool[numsrcs];
    for (unsigned int i = 0; i < numsrcs; i++) {
      completions[i] = false;
      erouter->addListener(this, EventBase::stateMachineEGID, reinterpret_cast<size_t>(getSources()[i]), EventBase::statusETID);
    };
  }
  
  //! stops listening
  virtual void stop() {
    erouter->removeListener(this);
    delete completions;
    completions = NULL;
    Transition::stop();
  }
  
  //! record completions, and fire the transition if all sources have completed
  virtual void doEvent() {
    switch ( event->getGeneratorID() ) {

    case EventBase::stateMachineEGID: {
      int numcomplete = 0;
      for ( unsigned int i=0; i<getSources().size(); i++ ) {
  if ( event->getSourceID() == reinterpret_cast<size_t>(getSources()[i]) )
    completions[i] = true;
  if ( completions[i] )
    ++numcomplete;
      }
      int const threshold = (minsrcs > 0 ? minsrcs : (int)getSources().size());
      if (numcomplete >= threshold) {
  savedEvent = *event;
  erouter->addTimer(this, 9999, 0, false);
  return;
      }
      break;
    }

    case EventBase::timerEGID:
    fire(savedEvent);
    break;

  default:
    std::cout << "CompletionTrans received unexpected event type: " << event->getDescription() << std::endl;
    }
  }
  
protected:
  //!@name Dummy functions to satisfy the compiler
  CompletionTrans(const CompletionTrans&);  //!< don't call this
  CompletionTrans& operator=(const CompletionTrans&);  //!< don't call this
  //@}
  
};

/*! @file
 * @brief Defines Completiontrans, which causes a transition if all sources have signalled completion
 * @author dst (Creator)
 */

#endif