Public Member Functions
	Task (const std::string &name, Tasks::Context &ctx)

void	onUpdateParameters (void)

void	onEntityResolution (void)

void	onRequestActivation (void)

void	onResourceAcquisition (void)

void	onResourceRelease (void)

void	onDeactivation (void)

void	consume (const IMC::PowerChannelState *msg)

void	consume (const IMC::VehicleMedium *msg)

void	consume (const IMC::Voltage *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::Message *	m_msg

unsigned	m_entity_id

DUNE::Monitors::MediumHandler	m_hand

IMC::PowerChannelState	m_power_channel_state

IMC::PowerChannelControl	m_power_channel_control

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	onReportEntityState (void)

virtual void	onResourceInitialization (void)

virtual void	onRequestDeactivation (void)

virtual void	onActivation (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

Constructor & Destructor Documentation

Sensors::CyclopsC7::Task::Task	(	const std::string &	name,
		Tasks::Context &	ctx
	)

inline

Constructor.

Parameters

[in]	name	task name.
[in]	ctx	context.

References DUNE::Tasks::Parameter::defaultValue(), Sensors::CyclopsC7::Arguments::elabel, Sensors::CyclopsC7::Arguments::factor, m_args, Sensors::CyclopsC7::Arguments::message_name, DUNE::Tasks::Task::param(), DUNE::Tasks::Task::paramActive(), Sensors::CyclopsC7::Arguments::power_channel, Sensors::CyclopsC7::Arguments::power_control, DUNE::Tasks::Task::setEntityState(), and DUNE::Tasks::Parameter::size().

Member Function Documentation

void Sensors::CyclopsC7::Task::consume ( const IMC::PowerChannelState * msg )

inline

References DUNE::Tasks::Task::activate(), DUNE::Tasks::Task::isActivating(), m_args, m_power_channel_state, Sensors::CyclopsC7::Arguments::power_channel, and Sensors::CyclopsC7::Arguments::power_control.

void Sensors::CyclopsC7::Task::consume ( const IMC::VehicleMedium * msg )

inline

References m_hand, and DUNE::Monitors::MediumHandler::update().

void Sensors::CyclopsC7::Task::consume ( const IMC::Voltage * msg )

inline

References DUNE::Tasks::Task::dispatch(), Sensors::CyclopsC7::Arguments::factor, DUNE::Tasks::Task::isActive(), DUNE::Monitors::MediumHandler::isUnderwater(), m_args, m_entity_id, m_hand, m_msg, and DUNE::Tasks::Task::setEntityState().

void Sensors::CyclopsC7::Task::onDeactivation ( void )

inlinevirtual

Called when the task stops normal execution and enters an idleness state.

Reimplemented from DUNE::Tasks::Task.

References DUNE::Tasks::Task::dispatch(), m_args, m_power_channel_control, m_power_channel_state, Sensors::CyclopsC7::Arguments::power_control, and DUNE::Tasks::Task::setEntityState().

void Sensors::CyclopsC7::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 Sensors::CyclopsC7::Arguments::elabel, m_args, m_entity_id, and DUNE::Tasks::Task::resolveEntity().

void Sensors::CyclopsC7::Task::onMain ( void )

inlinevirtual

Main loop.

Implements DUNE::Tasks::Task.

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

void Sensors::CyclopsC7::Task::onRequestActivation ( void )

inlinevirtual

Called when an external activation request is received.

Derived classes that need to perform extra steps to prepare normal execution should replace the default behaviour of immediate activation with calls to activate() when the request is completed or activationFailed() if the request cannot be honoured.

Reimplemented from DUNE::Tasks::Task.

References DUNE::Tasks::Task::activate(), DUNE::Tasks::Task::dispatch(), m_args, m_power_channel_control, m_power_channel_state, and Sensors::CyclopsC7::Arguments::power_control.