DUNE: Uniform Navigational Environment  2016.05.0
List of all members | Classes | Public Types | Public Member Functions | Public Attributes
Transports::Replay::Task Struct Reference

Classes

struct  Stats
 

Public Types

typedef std::map< std::string,
uint8_t > 		Name2Eid
 
typedef std::map< uint8_t,
std::string > 		Eid2Name
 
typedef std::map< uint8_t,
uint8_t > 		Eid2Eid
 
typedef std::map< std::string,
bool > 		ReplayMsg
 
typedef std::map< std::string,
Stats > 		StatsMap
 
- Public Types inherited from DUNE::Concurrency::Runnable
enum  State {
  StateStarting, StateRunning, StateStopping, StateDead,
  StateUnknown
}
 

Public Member Functions

 Task (const std::string &name, Tasks::Context &ctx)
 
void onUpdateParameters (void)
 
 ~Task (void)
 
void onEntityReservation (void)
 
void consume (const IMC::EstimatedState *es)
 
void consume (const IMC::ReplayControl *rc)
 
uint8_t mapEntity (uint8_t eid)
 
void startReplay (const std::string &file)
 
void stopReplay (void)
 
void displayStats (void)
 
void reset (void)
 
void onMain (void)
 
void updateStats (Stats &s, double delay)
 
void displayStats (Stats &s, const std::string &name, const std::string &units, double factor=1.0)
 
- Public Member Functions inherited from DUNE::Tasks::Task
 Task (const std::string &name, Context &context)
 
const char * getName (void) const
 
const char * getSystemName (void) const
 
unsigned int getSystemId (void) const
 
unsigned int getEntityId (void) const
 
unsigned int resolveEntity (const std::string &label) const
 
std::string resolveEntity (unsigned int id) const
 
DebugLevel getDebugLevel (void) const
 
uint16_t getActivationTime (void) const
 
uint16_t getDeactivationTime (void) const
 
unsigned int resolveSystemName (const std::string &name) const
 
const char * resolveSystemId (unsigned int id) const
 
void loadConfig (void)
 
void setPriority (unsigned int value)
 
unsigned int getPriority (void) const
 
void inf (const char *format,...) DUNE_PRINTF_FORMAT(2
 
void void war (const char *format,...) DUNE_PRINTF_FORMAT(2
 
void void void err (const char *format,...) DUNE_PRINTF_FORMAT(2
 
void void void void cri (const char *format,...) DUNE_PRINTF_FORMAT(2
 
void void void void void debug (const char *format,...) DUNE_PRINTF_FORMAT(2
 
void void void void void void trace (const char *format,...) DUNE_PRINTF_FORMAT(2
 
void void void void void void void spew (const char *format,...) DUNE_PRINTF_FORMAT(2
 
void void void void void void
void void 		dispatch (IMC::Message *msg, unsigned int flags=0)
 
void dispatch (IMC::Message &msg, unsigned int flags=0)
 
void dispatchReply (const IMC::Message &original, IMC::Message &msg, unsigned int flags=0)
 
void receive (const IMC::Message *msg)
 
void reserveEntities (void)
 
void resolveEntities (void)
 
void acquireResources (void)
 
void releaseResources (void)
 
void initializeResources (void)
 
void updateParameters (bool act_deact=true)
 
void writeParamsXML (std::ostream &os) const
 
const char * getEntityLabel (void) const
 
void setEntityLabel (const std::string &label)
 
- Public Member Functions inherited from DUNE::Tasks::AbstractTask
 AbstractTask (void)
 
virtual ~AbstractTask (void)
 
- Public Member Functions inherited from DUNE::Concurrency::Thread
 Thread (void)
 
virtual ~Thread (void)
 
int getProcessorUsage (void)
 
- Public Member Functions inherited from DUNE::Concurrency::Runnable
 Runnable (void)
 
virtual ~Runnable (void)
 
void start (void)
 
void stop (void)
 
void join (void)
 
void stopAndJoin (void)
 
void setPriority (Scheduler::Policy policy, unsigned priority)
 
State getState (void)
 
bool isCreated (void)
 
bool isStopping (void)
 
bool isRunning (void)
 
bool isStarting (void)
 
bool isDead (void)
 

Public Attributes

Arguments m_args
 
Name2Eid m_name2eid
 
Eid2Name m_eid2name
 
Eid2Eid m_eid2eid
 
ReplayMsg m_replay
 
double m_ts_delta
 
double m_start_time
 
std::istream * m_is
 
IMC::EstimatedState m_estate
 
StatsMap m_sstats
 
StatsMap m_tstats
 
Stats m_tgstats
 
double m_next_stats
 

Additional Inherited Members

- Protected Member Functions inherited from DUNE::Tasks::Task
void setEntityState (IMC::EntityState::StateEnum state, Status::Code code)
 
void setEntityState (IMC::EntityState::StateEnum state, const std::string &description)
 
IMC::EntityState::StateEnum getEntityState (void) const
 
unsigned int reserveEntity (const std::string &label)
 
template<typename E >
E * reserveEntity (const std::string &label)
 
bool stopping (void)
 
bool isActive (void) const
 
bool isActivating (void) const
 
bool isDeactivating (void) const
 
void waitForMessages (double timeout)
 
void consumeMessages (void)
 
template<typename T >
Parameter & param (const std::string &name, T &var)
 
template<typename Y , typename T >
Parameter & param (const std::string &name, T &var)
 
template<typename T >
bool paramChanged (T &var)
 
void paramActive (Parameter::Scope def_scope, Parameter::Visibility def_visibility, bool def_value=false)
 
void setParamSectionEditor (const std::string &name)
 
template<typename M , typename T >
void bind (T *task_obj, void(T::*consumer)(const M *)=&T::consume)
 
template<typename T >
void bind (T *task_obj, const std::vector< uint32_t > &list)
 
template<typename T , typename M >
void bind (T *task_obj, const std::vector< uint32_t > &list, void(T::*consumer)(const M *)=&T::consume)
 
template<typename T >
void bind (T *task_obj, const std::vector< std::string > &list)
 
void requestActivation (void)
 
void requestDeactivation (void)
 
void activate (void)
 
void activationFailed (const std::string &reason)
 
void deactivate (void)
 
void deactivationFailed (const std::string &reason)
 
virtual bool onWriteParamsXML (std::ostream &os) const
 
virtual void onEntityResolution (void)
 
virtual void onReportEntityState (void)
 
virtual void onResourceAcquisition (void)
 
virtual void onResourceRelease (void)
 
virtual void onResourceInitialization (void)
 
virtual void onRequestActivation (void)
 
virtual void onRequestDeactivation (void)
 
virtual void onActivation (void)
 
virtual void onDeactivation (void)
 
virtual void onQueryEntityParameters (const IMC::QueryEntityParameters *msg)
 
virtual void onSetEntityParameters (const IMC::SetEntityParameters *msg)
 
virtual void onPushEntityParameters (const IMC::PushEntityParameters *msg)
 
virtual void onPopEntityParameters (const IMC::PopEntityParameters *msg)
 
- Protected Member Functions inherited from DUNE::Concurrency::Thread
void startImpl (void)
 
void stopImpl (void)
 
void joinImpl (void)
 
void setPriorityImpl (Scheduler::Policy policy, unsigned priority)
 
- Protected Attributes inherited from DUNE::Tasks::Task
Context & m_ctx
 
std::vector
< Entities::BasicEntity * > 		m_entities
 

Member Typedef Documentation

typedef std::map<uint8_t, uint8_t> Transports::Replay::Task::Eid2Eid
typedef std::map<uint8_t, std::string> Transports::Replay::Task::Eid2Name
typedef std::map<std::string, uint8_t> Transports::Replay::Task::Name2Eid
typedef std::map<std::string, bool> Transports::Replay::Task::ReplayMsg
typedef std::map<std::string, Stats> Transports::Replay::Task::StatsMap

Constructor & Destructor Documentation

Transports::Replay::Task::Task ( const std::string &  name,
Tasks::Context &  ctx 
)
inline

References DUNE::Tasks::Parameter::defaultValue(), Transports::Replay::Arguments::ents, m_args, Transports::Replay::Arguments::msgs, DUNE::Tasks::Task::param(), and Transports::Replay::Arguments::startup_file.

Transports::Replay::Task::~Task ( void  )
inlinevirtual

Destructor.

Reimplemented from DUNE::Tasks::Task.

References reset().

Member Function Documentation

void Transports::Replay::Task::consume ( const IMC::EstimatedState *  es)
inline

References DUNE::Tasks::Task::getSystemId(), DUNE::Tasks::Task::isActive(), m_estate, m_sstats, and updateStats().

void Transports::Replay::Task::consume ( const IMC::ReplayControl *  rc)
inline

References DUNE::Tasks::Task::err(), startReplay(), and stopReplay().

void Transports::Replay::Task::displayStats ( void  )
inline

References m_sstats, m_tgstats, and m_tstats.

Referenced by onMain(), and stopReplay().

void Transports::Replay::Task::displayStats ( Stats &  s,
const std::string &  name,
const std::string &  units,
double  factor = 1.0 
)
inline

References Transports::Replay::Task::Stats::count, DUNE::Tasks::Task::debug(), m_start_time, Transports::Replay::Task::Stats::max, Transports::Replay::Task::Stats::min, Transports::Replay::Task::Stats::sum, and Transports::Replay::Task::Stats::sumsq.

uint8_t Transports::Replay::Task::mapEntity ( uint8_t  eid)
inline

References m_eid2eid.

Referenced by onMain().

void Transports::Replay::Task::onEntityReservation ( void  )
inlinevirtual

Called when the task is instructed to reserve all the entity identifiers it needs for normal execution.

See reserveEntity(). Derived classes that need to reserve entity identifiers other than that of the main entity should override this function.

Reimplemented from DUNE::Tasks::Task.

References Transports::Replay::Arguments::ents, m_args, m_eid2name, m_name2eid, and DUNE::Tasks::Task::reserveEntity().

void Transports::Replay::Task::onMain ( void  )
inlinevirtual

Implements DUNE::Tasks::Task.

References DUNE::Tasks::Task::consumeMessages(), DUNE::IMC::Packet::deserialize(), DUNE::Tasks::Task::dispatch(), displayStats(), DUNE::Tasks::Task::isActive(), m_args, m_eid2eid, m_eid2name, m_estate, m_is, m_name2eid, m_next_stats, m_replay, m_start_time, m_tgstats, m_ts_delta, m_tstats, mapEntity(), DUNE::Tasks::Task::spew(), startReplay(), Transports::Replay::Arguments::startup_file, DUNE::Tasks::Task::stopping(), stopReplay(), DUNE::Tasks::Task::trace(), updateStats(), and DUNE::Tasks::Task::waitForMessages().

void Transports::Replay::Task::onUpdateParameters ( void  )
inlinevirtual

Called when the task is instructed to update its run-time parameters.

Derived classes that need to compute auxiliary values based on run-time parameters should override this function.

Reimplemented from DUNE::Tasks::Task.

References m_args, m_replay, Transports::Replay::Arguments::msgs, and reset().

void Transports::Replay::Task::reset ( void  )
inline

References m_eid2eid, m_eid2name, m_is, m_name2eid, m_tgstats, m_tstats, and DUNE::Tasks::Task::requestDeactivation().

Referenced by onUpdateParameters(), startReplay(), stopReplay(), and ~Task().

void Transports::Replay::Task::startReplay ( const std::string &  file)
inline

References DUNE::Tasks::Task::dispatch(), DUNE::Tasks::Task::err(), DUNE::Tasks::Task::isActive(), m_is, m_next_stats, m_start_time, m_ts_delta, DUNE::Tasks::Task::requestActivation(), reset(), stopReplay(), and DUNE::Tasks::Task::war().

Referenced by consume(), and onMain().

void Transports::Replay::Task::stopReplay ( void  )
inline

References DUNE::Tasks::Task::dispatch(), displayStats(), reset(), and DUNE::Tasks::Task::war().

Referenced by consume(), onMain(), and startReplay().

void Transports::Replay::Task::updateStats ( Stats &  s,
double  delay 
)
inline

References Transports::Replay::Task::Stats::count, Transports::Replay::Task::Stats::max, Transports::Replay::Task::Stats::min, Transports::Replay::Task::Stats::sum, and Transports::Replay::Task::Stats::sumsq.

Referenced by consume(), and onMain().

Member Data Documentation

Arguments Transports::Replay::Task::m_args

Referenced by onEntityReservation(), onMain(), onUpdateParameters(), and Task().

Eid2Eid Transports::Replay::Task::m_eid2eid

Referenced by mapEntity(), onMain(), and reset().

Eid2Name Transports::Replay::Task::m_eid2name

Referenced by onEntityReservation(), onMain(), and reset().

IMC::EstimatedState Transports::Replay::Task::m_estate

Referenced by consume(), and onMain().

std::istream* Transports::Replay::Task::m_is

Referenced by onMain(), reset(), and startReplay().

Name2Eid Transports::Replay::Task::m_name2eid

Referenced by onEntityReservation(), onMain(), and reset().

double Transports::Replay::Task::m_next_stats

Referenced by onMain(), and startReplay().

ReplayMsg Transports::Replay::Task::m_replay

Referenced by onMain(), and onUpdateParameters().

StatsMap Transports::Replay::Task::m_sstats

Referenced by consume(), and displayStats().

double Transports::Replay::Task::m_start_time

Referenced by displayStats(), onMain(), and startReplay().

Stats Transports::Replay::Task::m_tgstats

Referenced by displayStats(), onMain(), and reset().

double Transports::Replay::Task::m_ts_delta

Referenced by onMain(), and startReplay().

StatsMap Transports::Replay::Task::m_tstats

Referenced by displayStats(), onMain(), and reset().

Collaboration diagram for Transports::Replay::Task:
Collaboration graph