DUNE: Uniform Navigational Environment  2024.09.0
List of all members | Public Member Functions | Public Attributes
Monitors::MantaFuelLevel::Task Struct Reference

Public Member Functions

 Task (const std::string &name, Tasks::Context &ctx)
 
void onEntityReservation (void)
 
void onResourceInitialization (void)
 
void consume (const IMC::Voltage *msg)
 
void consume (const IMC::Current *msg)
 
float getFuelLevelPercentage (void)
 
std::string fill (const std::string &var)
 
void parsePercentageValue (void)
 
void parseVoltageValue (void)
 
void sendToLCDPowerOff (void)
 
void task (void)
 
- Public Member Functions inherited from DUNE::Tasks::Periodic
 Periodic (const std::string &name, Context &ctx)
 
virtual ~Periodic (void)
 
void setFrequency (double freq)
 
double getFrequency (void) const
 
double getRunTime (void) const
 
unsigned getRunCount (void) const
 
- 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::FuelLevel m_fuel
 
IMC::LcdControl m_lcd
 
Arguments m_args
 
bool m_is_task_in_error
 
float m_battery_volts
 
float m_current_charge
 
char m_bufer_entity [64]
 
Counter< float > m_wdog
 

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)
 
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 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 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
 

Constructor & Destructor Documentation

◆ Task()

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

References Monitors::MantaFuelLevel::Arguments::chager_current, Monitors::MantaFuelLevel::Arguments::elabel_current_charger, Monitors::MantaFuelLevel::Arguments::elabel_fuel, Monitors::MantaFuelLevel::Arguments::elabel_voltage_main, Monitors::MantaFuelLevel::Arguments::fuel_level, Monitors::MantaFuelLevel::Arguments::is_to_use_voltage, Monitors::MantaFuelLevel::Arguments::shutdow_level, Monitors::MantaFuelLevel::Arguments::shutdow_level_voltage, Monitors::MantaFuelLevel::Arguments::warning_level, and Monitors::MantaFuelLevel::Arguments::warning_level_voltage.

Member Function Documentation

◆ consume() [1/2]

void Monitors::MantaFuelLevel::Task::consume ( const IMC::Voltage *  msg)
inline

Consume message IMC::Voltage.

References Monitors::MantaFuelLevel::Arguments::elabel_current_charger, and Monitors::MantaFuelLevel::Arguments::elabel_voltage_main.

◆ consume() [2/2]

void Monitors::MantaFuelLevel::Task::consume ( const IMC::Current *  msg)
inline

Consume message IMC::Current.

References Monitors::MantaFuelLevel::Arguments::chager_current, and Monitors::MantaFuelLevel::Arguments::elabel_current_charger.

◆ fill()

std::string Monitors::MantaFuelLevel::Task::fill ( const std::string &  var)
inline

◆ getFuelLevelPercentage()

float Monitors::MantaFuelLevel::Task::getFuelLevelPercentage ( void  )
inline

References DUNE::Math::abs(), and Monitors::MantaFuelLevel::Arguments::fuel_level.

◆ onEntityReservation()

void Monitors::MantaFuelLevel::Task::onEntityReservation ( void  )
inlinevirtual

Reserve entity identifiers.

Reimplemented from DUNE::Tasks::Task.

References Monitors::MantaFuelLevel::Arguments::elabel_fuel.

◆ onResourceInitialization()

void Monitors::MantaFuelLevel::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.

References Monitors::MantaFuelLevel::Arguments::fuel_level.

◆ parsePercentageValue()

void Monitors::MantaFuelLevel::Task::parsePercentageValue ( void  )
inline

References Monitors::MantaFuelLevel::Arguments::shutdow_level, and Monitors::MantaFuelLevel::Arguments::warning_level.

◆ parseVoltageValue()

void Monitors::MantaFuelLevel::Task::parseVoltageValue ( void  )
inline

References Monitors::MantaFuelLevel::Arguments::shutdow_level_voltage, and Monitors::MantaFuelLevel::Arguments::warning_level_voltage.

◆ sendToLCDPowerOff()

void Monitors::MantaFuelLevel::Task::sendToLCDPowerOff ( void  )
inline

◆ task()

void Monitors::MantaFuelLevel::Task::task ( void  )
inlinevirtual

The task to be executed on each cycle.

Implements DUNE::Tasks::Periodic.

References Monitors::MantaFuelLevel::Arguments::is_to_use_voltage.

Member Data Documentation

◆ m_args

Arguments Monitors::MantaFuelLevel::Task::m_args

Task arguments.

◆ m_battery_volts

float Monitors::MantaFuelLevel::Task::m_battery_volts

Voltage of battery pack.

◆ m_bufer_entity

char Monitors::MantaFuelLevel::Task::m_bufer_entity[64]

Buffer forEntityState.

◆ m_current_charge

float Monitors::MantaFuelLevel::Task::m_current_charge

Current of charge.

◆ m_fuel

IMC::FuelLevel Monitors::MantaFuelLevel::Task::m_fuel

IMC msg for fuel level.

◆ m_is_task_in_error

bool Monitors::MantaFuelLevel::Task::m_is_task_in_error

Flag to control state of task.

◆ m_lcd

IMC::LcdControl Monitors::MantaFuelLevel::Task::m_lcd

LCD Control Message.

◆ m_wdog

Counter<float> Monitors::MantaFuelLevel::Task::m_wdog

WatchDog for warning fuel level.

Collaboration diagram for Monitors::MantaFuelLevel::Task:
Collaboration graph