Supervisors::ClockPPS::Task Struct Reference

Public Member Functions
	Task (const std::string &name, Tasks::Context &ctx)
void	onResourceAcquisition (void)
void	onResourceRelease (void)
void	consume (const IMC::GpsFix *msg)
void	computeTimeOffset (const IMC::GpsFix *msg)
time_t	getTimeOffset (void)
bool	hasPPS (void)
int	getTimeX (void)
void	updateState (void)
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)
State	getState (void)
bool	isCreated (void)
bool	isStopping (void)
bool	isRunning (void)
bool	isStarting (void)
bool	isDead (void)

Public Attributes
SyncState	m_clk_state
std::list< time_t >	m_time_offsets
int	m_timex_status
LinuxPPS *	m_pps
Arguments	m_args

Additional Inherited Members
Public Types inherited from DUNE::Concurrency::Runnable
enum	State {   StateStarting, StateRunning, StateStopping, StateDead,   StateUnknown }
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	onEntityReservation (void)
virtual void	onEntityResolution (void)
virtual void	onReportEntityState (void)
virtual void	onResourceInitialization (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)
Protected Attributes inherited from DUNE::Tasks::Task
Context &	m_ctx
std::vector < Entities::BasicEntity * >	m_entities

Constructor & Destructor Documentation

Supervisors::ClockPPS::Task::Task ( const std::string &  name, Tasks::Context &  ctx  )

inline

Constructor.

Parameters

[in]	name	instance name.
[in]	ctx	context.

References DUNE::Tasks::Parameter::defaultValue(), DUNE::Tasks::Parameter::description(), Supervisors::ClockPPS::Arguments::gps_offset_count, m_args, DUNE::Tasks::Task::param(), Supervisors::ClockPPS::Arguments::pps_dev, Supervisors::ClockPPS::Arguments::pps_max_offset, Supervisors::ClockPPS::Arguments::pps_prop_delay, Supervisors::ClockPPS::Arguments::time_sync_cmd, Supervisors::ClockPPS::Arguments::uart_dev, and DUNE::Tasks::Parameter::units().

Member Function Documentation

void Supervisors::ClockPPS::Task::computeTimeOffset ( const IMC::GpsFix *  msg )

inline

References Supervisors::ClockPPS::Arguments::gps_offset_count, m_args, and m_time_offsets.

Referenced by consume().

void Supervisors::ClockPPS::Task::consume ( const IMC::GpsFix *  msg )

inline

References computeTimeOffset(), and DUNE::Tasks::Task::getSystemId().

time_t Supervisors::ClockPPS::Task::getTimeOffset ( void  )

inline

References m_time_offsets.

Referenced by updateState().

int Supervisors::ClockPPS::Task::getTimeX ( void  )

inline

Get adjtimex() status.

Returns

adjtimex() status.

Referenced by updateState().

bool Supervisors::ClockPPS::Task::hasPPS ( void  )

inline

References m_timex_status.

void Supervisors::ClockPPS::Task::onMain ( void  )

inlinevirtual

Implements DUNE::Tasks::Task.

References DUNE::Tasks::Task::stopping(), updateState(), and DUNE::Tasks::Task::waitForMessages().

void Supervisors::ClockPPS::Task::onResourceAcquisition ( void  )

inlinevirtual

Called when the task is instructed to acquire resources whose configuration is defined by run-time parameters.

Reimplemented from DUNE::Tasks::Task.

References m_args, m_pps, Supervisors::ClockPPS::Arguments::pps_dev, Supervisors::ClockPPS::Arguments::pps_prop_delay, and Supervisors::ClockPPS::Arguments::uart_dev.

void Supervisors::ClockPPS::Task::onResourceRelease ( void  )

inlinevirtual

Called when the task is instructed to release resources.

Derived classes that override this function must not assume that any resource was previously acquired. This function must be implemented in such a way that it can be called at any time.

Reimplemented from DUNE::Tasks::Task.

References m_pps.

void Supervisors::ClockPPS::Task::updateState ( void  )

inline

References DUNE::Tasks::Task::dispatch(), DUNE::Tasks::Task::err(), Supervisors::ClockPPS::LinuxPPS::getOffset(), Supervisors::ClockPPS::LinuxPPS::getOffsetMaximum(), Supervisors::ClockPPS::LinuxPPS::getOffsetMinimum(), getTimeOffset(), getTimeX(), Supervisors::ClockPPS::Arguments::gps_offset_count, m_args, m_clk_state, m_pps, m_time_offsets, Supervisors::ClockPPS::Arguments::pps_max_offset, Supervisors::ClockPPS::LinuxPPS::reset(), Supervisors::ClockPPS::LinuxPPS::resetLimits(), DUNE::Tasks::Task::setEntityState(), Supervisors::ClockPPS::SS_MONITOR, Supervisors::ClockPPS::SS_PPS_SETTLE, Supervisors::ClockPPS::SS_PPS_WAIT, Supervisors::ClockPPS::SS_SET_TIME, and Supervisors::ClockPPS::Arguments::time_sync_cmd.

Referenced by onMain().

Member Data Documentation

Arguments Supervisors::ClockPPS::Task::m_args

Task arguments.

Referenced by computeTimeOffset(), onResourceAcquisition(), Task(), and updateState().

SyncState Supervisors::ClockPPS::Task::m_clk_state

Current clock state.

Referenced by updateState().

LinuxPPS* Supervisors::ClockPPS::Task::m_pps

PPS consumer.

Referenced by onResourceAcquisition(), onResourceRelease(), and updateState().

std::list<time_t> Supervisors::ClockPPS::Task::m_time_offsets

List of time offsets.

Referenced by computeTimeOffset(), getTimeOffset(), and updateState().

int Supervisors::ClockPPS::Task::m_timex_status

Last adjtimex() status.

Referenced by hasPPS().

Collaboration diagram for Supervisors::ClockPPS::Task: