DUNE: Uniform Navigational Environment  2019.02.1
DUNE::Tasks::AbstractTask Class Referenceabstract

Public Member Functions

 AbstractTask (void)
 
virtual ~AbstractTask (void)
 
virtual void receive (const IMC::Message *msg)=0
 
virtual const char * getName (void) const =0
 
virtual void inf (const char *format,...) DUNE_PRINTF_FORMAT(2
 
virtual void virtual void war (const char *format,...) DUNE_PRINTF_FORMAT(2
 
virtual void virtual void virtual void err (const char *format,...) DUNE_PRINTF_FORMAT(2
 
virtual void virtual void virtual void virtual void cri (const char *format,...) DUNE_PRINTF_FORMAT(2
 
virtual void virtual void virtual void virtual void virtual void debug (const char *format,...) DUNE_PRINTF_FORMAT(2
 
virtual void virtual void virtual void virtual void virtual void virtual void trace (const char *format,...) DUNE_PRINTF_FORMAT(2
 
virtual void virtual void virtual void virtual void virtual void virtual void virtual void spew (const char *format,...) DUNE_PRINTF_FORMAT(2
 
- 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)
 

Additional Inherited Members

- Public Types inherited from DUNE::Concurrency::Runnable
- 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 Member Functions inherited from DUNE::Concurrency::Runnable
virtual void run (void)=0
 

Constructor & Destructor Documentation

DUNE::Tasks::AbstractTask::AbstractTask ( void  )
inline
virtual DUNE::Tasks::AbstractTask::~AbstractTask ( void  )
inlinevirtual

Destructor.

References cri(), debug(), err(), getName(), inf(), receive(), spew(), trace(), and war().

Member Function Documentation

virtual void virtual void virtual void virtual void DUNE::Tasks::AbstractTask::cri ( const char *  format,
  ... 
)
virtual

Send an human-readable critical error message to all configured output channels and files.

Parameters
formatstring format (similar to printf(3)).
...arguments.

Reimplemented in DUNE::Tasks::Task.

Referenced by ~AbstractTask().

virtual void virtual void virtual void virtual void virtual void DUNE::Tasks::AbstractTask::debug ( const char *  format,
  ... 
)
virtual

Send an human-readable debug message to all configured output channels and files.

The message will only be processed if the configured log level is DEBUG_LEVEL_DEBUG or greater.

Parameters
formatstring format (similar to printf(3)).
...arguments.

Reimplemented in DUNE::Tasks::Task.

Referenced by ~AbstractTask().

virtual void virtual void virtual void DUNE::Tasks::AbstractTask::err ( const char *  format,
  ... 
)
virtual

Send an human-readable error message to all configured output channels and files.

Parameters
formatstring format (similar to printf(3)).
...arguments.

Reimplemented in DUNE::Tasks::Task.

Referenced by ~AbstractTask().

virtual const char* DUNE::Tasks::AbstractTask::getName ( void  ) const
pure virtual

Retrieve task name.

Returns
task name.

Implemented in DUNE::Tasks::Task.

Referenced by DUNE::IMC::Bus::registerRecipient(), DUNE::Entities::BasicEntity::setLabel(), and ~AbstractTask().

virtual void DUNE::Tasks::AbstractTask::inf ( const char *  format,
  ... 
)
virtual

Send an human-readable informational message to all configured output channels and files.

Parameters
formatstring format (similar to printf(3)).
...arguments.

Reimplemented in DUNE::Tasks::Task.

Referenced by ~AbstractTask().

virtual void DUNE::Tasks::AbstractTask::receive ( const IMC::Message msg)
pure virtual

Queue a message for later consumption.

Parameters
msgmessage object.

Implemented in DUNE::Tasks::Task.

Referenced by ~AbstractTask().

virtual void virtual void virtual void virtual void virtual void virtual void virtual void DUNE::Tasks::AbstractTask::spew ( const char *  format,
  ... 
)
virtual

Send a very verbose or frequent human-readable debug message to all configured output channels and files.

The message will only be processed if the configured log level is DEBUG_LEVEL_SPEW.

Parameters
formatstring format (similar to printf(3)).
...arguments.

Reimplemented in DUNE::Tasks::Task.

Referenced by DUNE::Entities::StatefulEntity::requestActivation(), DUNE::Entities::StatefulEntity::requestDeactivation(), and ~AbstractTask().

virtual void virtual void virtual void virtual void virtual void virtual void DUNE::Tasks::AbstractTask::trace ( const char *  format,
  ... 
)
virtual

Send a verbose or frequent human-readable debug message to all configured output channels and files.

The message will only be processed if the configured log level is DEBUG_LEVEL_TRACE or greater.

Parameters
formatstring format (similar to printf(3)).
...arguments.

Reimplemented in DUNE::Tasks::Task.

Referenced by ~AbstractTask().

virtual void virtual void DUNE::Tasks::AbstractTask::war ( const char *  format,
  ... 
)
virtual

Send an human-readable warning message to all configured output channels and files.

Parameters
formatstring format (similar to printf(3)).
...arguments.

Reimplemented in DUNE::Tasks::Task.

Referenced by ~AbstractTask().

Collaboration diagram for DUNE::Tasks::AbstractTask:
Collaboration graph