scl::CNonControlTaskBase Class Reference

#include <CNonControlTaskBase.hpp>

Public Member Functions
virtual bool	computeTask ()=0
virtual bool	init (SNonControlTaskBase *arg_task_data)=0
virtual SNonControlTaskBase *	getTaskData ()=0
virtual void	reset ()=0
virtual void	setActivation (sBool arg_act)
virtual sBool	hasBeenInit ()
virtual bool	hasBeenActivated ()
	CNonControlTaskBase ()
virtual	~CNonControlTaskBase ()

Protected Attributes
sBool	has_been_init_

Detailed Description

Container class to encapsulate a non-control task that a controller might have to do (like log stuff etc.).

NOTE : Virtual class. Subclass and implement functions that compute the task forces.

Constructor & Destructor Documentation

scl::CNonControlTaskBase::CNonControlTaskBase ( )

inline

Constructor does nothing

virtual scl::CNonControlTaskBase::~CNonControlTaskBase ( )

inlinevirtual

Destructor does nothing

Member Function Documentation

virtual bool scl::CNonControlTaskBase::computeTask ( )

pure virtual

Computes the task's stuff (whatever that might be)

virtual SNonControlTaskBase* scl::CNonControlTaskBase::getTaskData ( )

pure virtual

Return this task controller's task data structure. Use it responsibly! NOTE : Use dynamic casts whenever you downcast the data. And try not to downcast very often. Perf hit.

virtual bool scl::CNonControlTaskBase::hasBeenActivated ( )

inlinevirtual

Present activation state

virtual sBool scl::CNonControlTaskBase::hasBeenInit ( )

inlinevirtual

Present initialization state

virtual bool scl::CNonControlTaskBase::init ( SNonControlTaskBase *  arg_task_data )

pure virtual

Initializes the task object. Create a subclass of STaskBase if your task requires more data than the defaults in STaskBase provide. This function should set has_been_init_ to true

NOTE : This is typically a one time operation, unlike activation.

virtual void scl::CNonControlTaskBase::reset ( )

pure virtual

Resets the task to pre-init.

virtual void scl::CNonControlTaskBase::setActivation ( sBool  arg_act )

inlinevirtual

NOTE : This is typically a dynamic operation that happens multiple times during runtime.

Member Data Documentation

sBool scl::CNonControlTaskBase::has_been_init_

protected

The independent initialization of the computational object from the data structure

---

The documentation for this class was generated from the following file:

• /home/samir/Code/control/scl.git/src/scl/control/task/CNonControlTaskBase.hpp