ORCA: Optimization-based framework for Robotic Control Applications
Public Types | Public Member Functions | Protected Member Functions | List of all members
orca::common::Wrench Class Reference

#include <Wrench.h>

+ Inheritance diagram for orca::common::Wrench:
+ Collaboration diagram for orca::common::Wrench:

Public Types

using Ptr = std::shared_ptr< Wrench >
 
- Public Types inherited from orca::common::TaskBase
enum  State {
  Init = 0, Resized, Activating, Activated,
  Deactivating, Deactivated, Error
}
 Represents the internal state of the task. More...
 
using Ptr = std::shared_ptr< TaskBase >
 
- Public Types inherited from orca::common::ConfigurableOrcaObject
using Ptr = std::shared_ptr< ConfigurableOrcaObject >
 
using ParamMap = std::map< std::string, ParameterBase *>
 

Public Member Functions

 Wrench (const std::string &name)
 
void setBaseFrame (const std::string &base_ref_frame)
 
void setControlFrame (const std::string &control_frame)
 
void setCurrentValue (const Eigen::Matrix< double, 6, 1 > &current_wrench_from_ft_sensor)
 
const Eigen::Matrix< double, 6, 1 > & getCurrentValue () const
 
const std::string & getBaseFrame () const
 
const std::string & getControlFrame () const
 
const Eigen::MatrixXd & getJacobianTranspose () const
 
const Eigen::MatrixXd & getJacobian () const
 
void print () const
 
- Public Member Functions inherited from orca::common::TaskBase
 TaskBase (const std::string &name, optim::ControlVariable control_var)
 
virtual ~TaskBase ()
 
bool isActivated () const
 
bool isComputing () const
 
bool setRobotModel (robot::RobotModel::Ptr robot)
 
optim::ControlVariable getControlVariable () const
 
virtual bool activate ()
 
virtual void update (double current_time, double dt)
 
virtual bool deactivate ()
 
virtual bool setProblem (std::shared_ptr< const orca::optim::Problem > problem)
 
bool hasProblem () const
 
bool hasRobot () const
 
bool dependsOnProblem () const
 
bool dependsOnWrench () const
 
bool dependsOnRobotJoints () const
 
bool dependsOnFloatingBase () const
 
bool hasWrench () const
 
bool isRobotInitialized () const
 
State getState () const
 
void setRampDuration (double ramp_time)
 
double getRampDuration () const
 
double getCurrentRampValue () const
 
double getStartTime () const
 
double getStopTime () const
 
std::shared_ptr< const optim::ProblemgetProblem () const
 
std::shared_ptr< const common::WrenchgetWrench () const
 
std::shared_ptr< const robot::RobotModelgetRobot () const
 
void addChild (TaskBase::Ptr e)
 Add a child/slave task that will be updated BEFORE the parent task. More...
 
bool hasParent () const
 Returns true if the task owned by a parent task. More...
 
bool hasChildren () const
 Returns true if the task has children. More...
 
const std::string & getParentName () const
 Returns the parent name if it exists, empty otherwise. More...
 
const std::string & getPrintableName () const
 Returns the name that include parent name if present. More...
 
void onResizedCallback (std::function< void(void)> cb)
 
void onActivationCallback (std::function< void(void)> cb)
 
void onActivatedCallback (std::function< void(void)> cb)
 
void onComputeBeginCallback (std::function< void(double, double)> cb)
 
void onComputeEndCallback (std::function< void(double, double)> cb)
 
void onDeactivationCallback (std::function< void(void)> cb)
 
void onDeactivatedCallback (std::function< void(void)> cb)
 
- Public Member Functions inherited from orca::common::ConfigurableOrcaObject
 ConfigurableOrcaObject (const std::string &config_name)
 
virtual ~ConfigurableOrcaObject ()
 
template<class T >
void addParameter (const std::string &param_name, Parameter< T > *param, ParamPolicy policy=ParamPolicy::Required, std::function< void()> on_loading_success=0)
 Returns true if all params added with have been set. More...
 
template<class T >
void addParameter (const std::string &param_name, T &param, ParamPolicy policy=ParamPolicy::Required, std::function< void()> on_loading_success=0)
 
ParameterBasegetParameter (const std::string &param_name)
 Returns a param via its name. More...
 
void printParameters () const
 Print all parameters to std::cout. More...
 
bool configureFromFile (const std::string &yaml_url)
 Configure the task from YAML/JSON file. It must contain all the required parameters. More...
 
bool configureFromString (const std::string &yaml_str)
 Configure the task from YAML/JSON string. It must contain all the required parameters. More...
 
bool isConfigured () const
 
const ParamMapgetParameters () const
 
void onConfigureSuccess (std::function< void()> f)
 
- Public Member Functions inherited from orca::common::OrcaObject
 OrcaObject (const std::string &name)
 
virtual ~OrcaObject ()
 
const std::string & getName () const
 
void setName (const std::string &name)
 

Protected Member Functions

void onCompute (double current_time, double dt)
 
void onActivation ()
 
void onResize ()
 
void onDeactivated ()
 
- Protected Member Functions inherited from orca::common::TaskBase
virtual void resize ()
 
robot::RobotModel::Ptr robot ()
 
std::shared_ptr< Wrenchwrench ()
 
virtual void onResized ()
 
virtual void onActivated ()
 
virtual bool rampUp (double time_since_start)
 
void setRampValue (double new_val)
 
virtual bool rampDown (double time_since_stop)
 
virtual void onDeactivation ()
 

Additional Inherited Members

- Public Attributes inherited from orca::common::TaskBase
orca::common::MutexRecursive mutex
 The recursive mutex that is locked during the update function. It is up to the external user to lock this mutex to protect the task attributes. More...
 

Member Typedef Documentation

◆ Ptr

using orca::common::Wrench::Ptr = std::shared_ptr<Wrench>

Constructor & Destructor Documentation

◆ Wrench()

Wrench::Wrench ( const std::string &  name)

Member Function Documentation

◆ getBaseFrame()

const std::string & Wrench::getBaseFrame ( ) const

◆ getControlFrame()

const std::string & Wrench::getControlFrame ( ) const

◆ getCurrentValue()

const Eigen::Matrix< double, 6, 1 > & Wrench::getCurrentValue ( ) const

◆ getJacobian()

const Eigen::MatrixXd & Wrench::getJacobian ( ) const

◆ getJacobianTranspose()

const Eigen::MatrixXd & Wrench::getJacobianTranspose ( ) const

◆ onActivation()

void Wrench::onActivation ( )
protectedvirtual

Reimplemented from orca::common::TaskBase.

◆ onCompute()

void Wrench::onCompute ( double  current_time,
double  dt 
)
protectedvirtual

◆ onDeactivated()

void Wrench::onDeactivated ( )
protectedvirtual

Reimplemented from orca::common::TaskBase.

◆ onResize()

void Wrench::onResize ( )
protectedvirtual

◆ print()

void Wrench::print ( ) const
virtual

Reimplemented from orca::common::TaskBase.

◆ setBaseFrame()

void Wrench::setBaseFrame ( const std::string &  base_ref_frame)

◆ setControlFrame()

void Wrench::setControlFrame ( const std::string &  control_frame)

◆ setCurrentValue()

void Wrench::setCurrentValue ( const Eigen::Matrix< double, 6, 1 > &  current_wrench_from_ft_sensor)

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