DUNE: Uniform Navigational Environment  2024.09.0
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, StatsStatsMap
 
- 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 updateEntityMap (IMC::Message *m)
 
void startReplay (const std::string &file)
 
IMC::Message * getFirstMessageAfterSkip (double time_to_skip)
 
void stopReplay (void)
 
void displayStats (void)
 
void reset (void)
 
void dispatchWithNewTime (IMC::Message *m)
 
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)
 
unsigned getPriority (void)
 
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)
 
Entities::BasicEntitygetLocalEntity (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 >
Parameterparam (const std::string &name, T &var)
 
template<typename Y , typename T >
Parameterparam (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 bind (unsigned int message_id, AbstractConsumer *consumer)
 
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)
 
unsigned getPriorityImpl (void)
 
- Protected Attributes inherited from DUNE::Tasks::Task
Contextm_ctx
 
std::vector< Entities::BasicEntity * > m_entities
 

Member Typedef Documentation

◆ Eid2Eid

typedef std::map<uint8_t, uint8_t> Transports::Replay::Task::Eid2Eid

◆ Eid2Name

typedef std::map<uint8_t, std::string> Transports::Replay::Task::Eid2Name

◆ Name2Eid

typedef std::map<std::string, uint8_t> Transports::Replay::Task::Name2Eid

◆ ReplayMsg

typedef std::map<std::string, bool> Transports::Replay::Task::ReplayMsg

◆ StatsMap

typedef std::map<std::string, Stats> Transports::Replay::Task::StatsMap

Constructor & Destructor Documentation

◆ Task()

◆ ~Task()

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

Destructor.

Reimplemented from DUNE::Tasks::Task.

Member Function Documentation

◆ consume() [1/2]

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

◆ consume() [2/2]

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

◆ dispatchWithNewTime()

void Transports::Replay::Task::dispatchWithNewTime ( IMC::Message *  m)
inline

◆ displayStats() [1/2]

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

◆ displayStats() [2/2]

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

◆ getFirstMessageAfterSkip()

IMC::Message* Transports::Replay::Task::getFirstMessageAfterSkip ( double  time_to_skip)
inline

◆ mapEntity()

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

◆ onEntityReservation()

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.

◆ onMain()

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

◆ onUpdateParameters()

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 Transports::Replay::Arguments::msgs, and Transports::Replay::Arguments::time_multiplier.

◆ reset()

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

◆ startReplay()

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

◆ stopReplay()

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

◆ updateEntityMap()

void Transports::Replay::Task::updateEntityMap ( IMC::Message *  m)
inline

◆ updateStats()

Member Data Documentation

◆ m_args

Arguments Transports::Replay::Task::m_args

◆ m_eid2eid

Eid2Eid Transports::Replay::Task::m_eid2eid

◆ m_eid2name

Eid2Name Transports::Replay::Task::m_eid2name

◆ m_estate

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

◆ m_is

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

◆ m_name2eid

Name2Eid Transports::Replay::Task::m_name2eid

◆ m_next_stats

double Transports::Replay::Task::m_next_stats

◆ m_replay

ReplayMsg Transports::Replay::Task::m_replay

◆ m_sstats

StatsMap Transports::Replay::Task::m_sstats

◆ m_start_time

double Transports::Replay::Task::m_start_time

◆ m_tgstats

Stats Transports::Replay::Task::m_tgstats

◆ m_ts_delta

double Transports::Replay::Task::m_ts_delta

◆ m_tstats

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