Monitors::Entities::Task Struct Reference

Public Types
typedef std::set< uint8_t >	EIdSet
Public Types inherited from DUNE::Concurrency::Runnable

Public Member Functions
	Task (const std::string &name, Tasks::Context &ctx)
void	onResourceInitialization (void)
void	onEntityResolution (void)
void	setupDefaults (const std::vector< std::string > &ents)
void	consume (const IMC::EntityState *msg)
void	onReportEntityState (void)
void	consume (const IMC::MonitorEntityState *mes)
void	enableDefaults (bool startup=false)
void	enable (uint8_t eid, bool startup=false)
void	disable (uint8_t eid)
void	activate (const std::string &enames, uint8_t cmd)
void	reportState (void)
void	onTimeoutCheck (void)
void	setLastError (std::string msg)
void	onMain (void)
Public Member Functions inherited from DUNE::Tasks::Task
	Task (const std::string &name, Context &context)
virtual	~Task (void)
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
IMC::EntityMonitoringState	m_ems
std::vector< ESRecord >	m_record
EIdSet	m_current
EIdSet	m_defaults
Arguments	m_args

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::BasicEntity *	getLocalEntity (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	onEntityReservation (void)
virtual void	onResourceAcquisition (void)
virtual void	onResourceRelease (void)
virtual void	onUpdateParameters (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
Context &	m_ctx
std::vector< Entities::BasicEntity * >	m_entities

Member Typedef Documentation

typedef std::set<uint8_t> Monitors::Entities::Task::EIdSet

Type to store all Entity Ids.

Constructor & Destructor Documentation

Monitors::Entities::Task::Task ( const std::string &  name, Tasks::Context &  ctx  )

inline

References Monitors::Entities::Arguments::defmon, Monitors::Entities::Arguments::defmon_hw, Monitors::Entities::Arguments::max_transitions, Monitors::Entities::Arguments::report_timeout, and Monitors::Entities::Arguments::transition_gap.

Member Function Documentation

void Monitors::Entities::Task::activate ( const std::string &  enames, uint8_t  cmd  )

inline

Activate monitorings.

Parameters

[in]	enames	entity names
[in]	cmd	entity state monitoring command

References DUNE::Utils::String::split().

void Monitors::Entities::Task::consume ( const IMC::EntityState *  msg )

inline

References Monitors::Entities::ESRecord::label, Monitors::Entities::ESRecord::last_transition, Monitors::Entities::Arguments::max_transitions, Monitors::Entities::ESRecord::monitor, Monitors::Entities::ESRecord::state, Monitors::Entities::ESRecord::time, Monitors::Entities::Arguments::transition_gap, and Monitors::Entities::ESRecord::transitions.

void Monitors::Entities::Task::consume ( const IMC::MonitorEntityState *  mes )

inline

void Monitors::Entities::Task::disable ( uint8_t  eid )

inline

Disable monitoring for an entity.

Parameters

[in]

eid

entity ID

References Monitors::Entities::ESRecord::label, and Monitors::Entities::ESRecord::monitor.

void Monitors::Entities::Task::enable ( uint8_t  eid, bool  startup = false  )

inline

Enable monitoring for an entity.

Parameters

[in]	eid	entity ID
[in]	startup	true if task is just starting

References Monitors::Entities::ESRecord::label, Monitors::Entities::ESRecord::monitor, and Monitors::Entities::ESRecord::state.

void Monitors::Entities::Task::enableDefaults ( bool  startup = false )

inline

Enable configuration defaults.

Parameters

[in]

startup

true if the task is just starting

void Monitors::Entities::Task::onEntityResolution ( void  )

inlinevirtual

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

See resolveEntity(). Derived classes that need to resolve entity identifiers should override this function.

Reimplemented from DUNE::Tasks::Task.

References Monitors::Entities::Arguments::defmon, Monitors::Entities::Arguments::defmon_hw, Monitors::Entities::ESRecord::ESRecord(), and Monitors::Entities::ESRecord::label.

void Monitors::Entities::Task::onMain ( void  )

inlinevirtual

Implements DUNE::Tasks::Task.

void Monitors::Entities::Task::onReportEntityState ( void  )

inlinevirtual

Called when the task is instructed to report the state of its entities.

Derived classes that need to report the state of entities other than the main entity should override this function to dispatch the EntityState of those entities.

Reimplemented from DUNE::Tasks::Task.

void Monitors::Entities::Task::onResourceInitialization ( void  )

inlinevirtual

Called when the task is instructed to initialize resources acquired previously or whose initialization depends on run-time parameters.

Reimplemented from DUNE::Tasks::Task.

void Monitors::Entities::Task::onTimeoutCheck ( void  )

inline

Check if any entity has timedout.

References Monitors::Entities::ESRecord::label, Monitors::Entities::ESRecord::monitor, Monitors::Entities::Arguments::report_timeout, Monitors::Entities::ESRecord::state, and Monitors::Entities::ESRecord::time.

void Monitors::Entities::Task::reportState ( void  )

inline

Dispatch Entity Monitoring State.

References Monitors::Entities::ESRecord::label, and Monitors::Entities::ESRecord::state.

void Monitors::Entities::Task::setLastError ( std::string  msg )

inline

Setting last monitoring state error.

Parameters

[in]

msg

error message

void Monitors::Entities::Task::setupDefaults ( const std::vector< std::string > &  ents )

inline

Fill default entities vector.

Parameters

[in]

ents

vector of entity labels

Member Data Documentation

Arguments Monitors::Entities::Task::m_args

Task arguments.

EIdSet Monitors::Entities::Task::m_current

Ids of all currently monitored entities.

EIdSet Monitors::Entities::Task::m_defaults

Ids of monitored entities for default settings.

IMC::EntityMonitoringState Monitors::Entities::Task::m_ems

Entity Monitoring State message.

std::vector<ESRecord> Monitors::Entities::Task::m_record

Record of all available entity information.

Collaboration diagram for Monitors::Entities::Task: