scl::CTaskNULL Class Reference

#include <CTaskNULL.hpp>

Inheritance diagram for scl::CTaskNULL:

Collaboration diagram for scl::CTaskNULL:

Public Member Functions
	CTaskNULL ()
virtual	~CTaskNULL ()
virtual bool	init (STaskBase *arg_task_data, CDynamicsBase *arg_dynamics)
virtual STaskBase *	getTaskData ()
virtual void	reset ()
virtual bool	computeServo (const SRobotSensors *arg_sensors)
virtual bool	computeModel (const SRobotSensors *arg_sensors)
virtual bool	setGoalPos (const Eigen::VectorXd &arg_goal)
virtual bool	setGoalVel (const Eigen::VectorXd &arg_goal)
virtual bool	setGoalAcc (const Eigen::VectorXd &arg_goal)
virtual bool	getGoalPos (Eigen::VectorXd &arg_goal) const
virtual bool	getGoalVel (Eigen::VectorXd &arg_goal) const
virtual bool	getGoalAcc (Eigen::VectorXd &arg_goal) const
virtual bool	getPos (Eigen::VectorXd &arg_pos) const
virtual bool	getVel (Eigen::VectorXd &arg_vel) const
virtual bool	getAcc (Eigen::VectorXd &arg_acc) const
virtual sBool	hasBeenInit ()
virtual sBool	setActivated (sBool arg_activate)
virtual sBool	hasBeenActivated ()

Protected Attributes
sBool	has_been_init_
CDynamicsBase *	dynamics_

Private Attributes
STaskBase *	data_

Detailed Description

A null task. Does nothing. Yes it really does nothing.

Q) Why does it exist? A) For debugging.

Constructor & Destructor Documentation

scl::CTaskNULL::CTaskNULL ( )

inline

Constructor sets initialization state to false

virtual scl::CTaskNULL::~CTaskNULL ( )

inlinevirtual

Destructor does nothing.

Member Function Documentation

bool scl::CTaskNULL::computeModel ( const SRobotSensors *  arg_sensors )

virtual

Computes the dynamics (task model)

Implements scl::CTaskBase.

bool scl::CTaskNULL::computeServo ( const SRobotSensors *  arg_sensors )

virtual

Computes the task torques

Implements scl::CTaskBase.

virtual bool scl::CTaskBase::getAcc ( Eigen::VectorXd &  arg_acc ) const

inlinevirtualinherited

Gets the current acceleration. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, and scl::CTaskComPos.

virtual bool scl::CTaskBase::getGoalAcc ( Eigen::VectorXd &  arg_goal ) const

inlinevirtualinherited

Gets the current goal acceleration. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, scl::CTaskGcSet, scl::CTaskComPos, and scl::CTaskGc.

virtual bool scl::CTaskBase::getGoalPos ( Eigen::VectorXd &  arg_goal ) const

inlinevirtualinherited

Gets the current goal position. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, scl::CTaskGcSet, scl::CTaskComPos, scl::CTaskGcLimitCentering, and scl::CTaskGc.

virtual bool scl::CTaskBase::getGoalVel ( Eigen::VectorXd &  arg_goal ) const

inlinevirtualinherited

Gets the current goal velocity. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, scl::CTaskGcSet, scl::CTaskComPos, and scl::CTaskGc.

virtual bool scl::CTaskBase::getPos ( Eigen::VectorXd &  arg_pos ) const

inlinevirtualinherited

Gets the current position. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, scl::CTaskComPos, and scl::CTaskGcLimitCentering.

STaskBase * scl::CTaskNULL::getTaskData ( )

virtual

Return this task controller's task data structure.

Implements scl::CTaskBase.

virtual bool scl::CTaskBase::getVel ( Eigen::VectorXd &  arg_vel ) const

inlinevirtualinherited

Gets the current velocity. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, and scl::CTaskComPos.

virtual sBool scl::CTaskBase::hasBeenActivated ( )

inlinevirtualinherited

Activated = All dynamic parameters and data structures are up to date and task is actively contributing to a controller.

virtual sBool scl::CTaskBase::hasBeenInit ( )

inlinevirtualinherited

Initialized = All static parameters are set and data structures are up to date. Ready to contribute to a controller.

bool scl::CTaskNULL::init ( STaskBase *  arg_task_data, CDynamicsBase *  arg_dynamics  )

virtual

Initializes the task object. Required to set output gc force dofs

Implements scl::CTaskBase.

void scl::CTaskNULL::reset ( )

virtual

Resets the task by removing its data. NOTE : Does not deallocate its data structure

Implements scl::CTaskBase.

virtual sBool scl::CTaskBase::setActivated ( sBool  arg_activate )

inlinevirtualinherited

Activated = All dynamic parameters and data structures are up to date and task is actively contributing to a controller.

Set to true/false during runtime to activate/deactivate task.

Returns : success/failure

virtual bool scl::CTaskBase::setGoalAcc ( const Eigen::VectorXd &  arg_goal )

inlinevirtualinherited

Sets the current goal acceleration. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosContactForce, scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, scl::CTaskGcSet, scl::CTaskComPos, and scl::CTaskGc.

virtual bool scl::CTaskBase::setGoalPos ( const Eigen::VectorXd &  arg_goal )

inlinevirtualinherited

Sets the current goal position. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, scl::CTaskGcSet, scl::CTaskComPos, scl::CTaskGcLimitCentering, and scl::CTaskGc.

virtual bool scl::CTaskBase::setGoalVel ( const Eigen::VectorXd &  arg_goal )

inlinevirtualinherited

Sets the current goal velocity. Returns false if not supported by task.

Reimplemented in scl::CTaskOpPosContactForce, scl::CTaskOpPosPIDA1OrderInfTime, scl::CTaskOpPos, scl::CTaskGcSet, scl::CTaskComPos, and scl::CTaskGc.

Member Data Documentation

STaskBase* scl::CTaskNULL::data_

private

The kinematic and dynamic data required to compute any arbitrary task.

CDynamicsBase* scl::CTaskBase::dynamics_

protectedinherited

A Dynamics model required to compute the task's dynamics

sBool scl::CTaskBase::has_been_init_

protectedinherited

Initialized = All static parameters are set and data structures are up to date.

Set to true in init()

---

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

• /home/samir/Code/control/scl.git/src/scl/control/task/tasks/CTaskNULL.hpp
• /home/samir/Code/control/scl.git/src/scl/control/task/tasks/CTaskNULL.cpp