EEROS  1.0.0.0
API for the EEROS Real-Time Robotics Framework
eeros::sequencer::BaseSequence Class Referenceabstract

#include <BaseSequence.hpp>

Inheritance diagram for eeros::sequencer::BaseSequence:
Collaboration diagram for eeros::sequencer::BaseSequence:

Public Member Functions

 BaseSequence (Sequencer &seq, BaseSequence *caller, bool blocking)
 
virtual ~BaseSequence ()
 
virtual int start ()=0
 
virtual bool checkPreCondition ()
 
virtual bool checkExitCondition ()
 
void setName (std::string name)
 
std::string getName () const
 
void setId (int id)
 
int getId () const
 
BaseSequencegetCallerSequence ()
 
std::vector< BaseSequence * > getCallerStack () const
 
SequenceState getRunningState () const
 
void setPollingTime (int timeInMilliseconds)
 
void addMonitor (Monitor *monitor)
 
std::vector< Monitor * > getMonitors () const
 
void setTimeoutTime (double timeoutInSec)
 
void resetTimeout ()
 
void setTimeoutBehavior (SequenceProp behavior)
 
void setTimeoutExceptionSequence (BaseSequence &sequence)
 
void resetAbort ()
 

Public Attributes

std::vector< Monitor * > monitors
 

Protected Member Functions

virtual int action ()
 
virtual int operator() ()=0
 

Protected Attributes

std::string name
 
Sequencerseq
 
BaseSequencecaller
 
bool blocking
 
bool exceptionIsActive = false
 
bool inExcProcessing = false
 
SequenceState state
 
Logger log
 

Friends

class Monitor
 
class Sequencer
 

Constructor & Destructor Documentation

eeros::sequencer::BaseSequence::BaseSequence ( Sequencer seq,
BaseSequence caller,
bool  blocking 
)
eeros::sequencer::BaseSequence::~BaseSequence ( )
virtual

Member Function Documentation

int eeros::sequencer::BaseSequence::action ( )
protectedvirtual
void eeros::sequencer::BaseSequence::addMonitor ( Monitor monitor)
bool eeros::sequencer::BaseSequence::checkExitCondition ( )
virtual
bool eeros::sequencer::BaseSequence::checkPreCondition ( )
virtual
BaseSequence * eeros::sequencer::BaseSequence::getCallerSequence ( )
std::vector< BaseSequence * > eeros::sequencer::BaseSequence::getCallerStack ( ) const
int eeros::sequencer::BaseSequence::getId ( ) const
std::vector< Monitor * > eeros::sequencer::BaseSequence::getMonitors ( ) const
std::string eeros::sequencer::BaseSequence::getName ( ) const
SequenceState eeros::sequencer::BaseSequence::getRunningState ( ) const
virtual int eeros::sequencer::BaseSequence::operator() ( )
protectedpure virtual
void eeros::sequencer::BaseSequence::resetAbort ( )
void eeros::sequencer::BaseSequence::resetTimeout ( )
void eeros::sequencer::BaseSequence::setId ( int  id)
void eeros::sequencer::BaseSequence::setName ( std::string  name)
void eeros::sequencer::BaseSequence::setPollingTime ( int  timeInMilliseconds)
void eeros::sequencer::BaseSequence::setTimeoutBehavior ( SequenceProp  behavior)
void eeros::sequencer::BaseSequence::setTimeoutExceptionSequence ( BaseSequence sequence)
void eeros::sequencer::BaseSequence::setTimeoutTime ( double  timeoutInSec)
virtual int eeros::sequencer::BaseSequence::start ( )
pure virtual

Friends And Related Function Documentation

friend class Monitor
friend
friend class Sequencer
friend

Member Data Documentation

bool eeros::sequencer::BaseSequence::blocking
protected
BaseSequence* eeros::sequencer::BaseSequence::caller
protected
bool eeros::sequencer::BaseSequence::exceptionIsActive = false
protected
bool eeros::sequencer::BaseSequence::inExcProcessing = false
protected
Logger eeros::sequencer::BaseSequence::log
protected
std::vector<Monitor*> eeros::sequencer::BaseSequence::monitors
std::string eeros::sequencer::BaseSequence::name
protected
Sequencer& eeros::sequencer::BaseSequence::seq
protected
SequenceState eeros::sequencer::BaseSequence::state
protected

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