#include <mc_tvm/OrientationFunction.h>

Inheritance diagram for mc_tvm::OrientationFunction:

[legend]

Collaboration diagram for mc_tvm::OrientationFunction:

[legend]

Public Member Functions
	OrientationFunction (const mc_rbdyn::RobotFrame &frame)

void	reset ()

const Eigen::Matrix3d &	orientation () const noexcept

void	orientation (const Eigen::Matrix3d &ori) noexcept

const Eigen::Vector3d &	refVel () const noexcept

void	refVel (const Eigen::Vector3d &refVel) noexcept

const Eigen::Vector3d &	refAccel () const noexcept

void	refAccel (const Eigen::Vector3d &refAccel) noexcept

const mc_rbdyn::RobotFrame &	frame () const noexcept

Public Member Functions inherited from tvm::function::abstract::Function
virtual const Eigen::VectorXd &	velocity () const

virtual const Eigen::VectorXd &	normalAcceleration () const

virtual MatrixConstRef	JDot (const Variable &x) const

Public Member Functions inherited from tvm::internal::FirstOrderProvider
virtual const Eigen::VectorXd &	value () const

virtual MatrixConstRefWithProperties	jacobian (const Variable &x) const

bool	linearIn (const Variable &x) const

const Space &	imageSpace () const

int	size () const

int	rSize () const

int	tSize () const

const VariableVector &	variables () const

Public Member Functions inherited from tvm::graph::internal::AbstractNode
bool	isUpdateEnabled (EnumT e) const

virtual bool	isUpdateStaticallyEnabled (int) const

virtual bool	isUpdateCustomEnabled (int) const

virtual	~AbstractNode ()=default

void	update (int i)

Public Member Functions inherited from tvm::graph::internal::Inputs
virtual	~Inputs ()=default

void	addInput (std::shared_ptr< T > source, EnumI i, Args... args)

void	addInput (T &source, EnumI i, Args... args)

void	removeInput (T *source)

void	removeInput (T *source, Args... args)

Iterator	getInput (T *source)

Iterator	getInput (const std::shared_ptr< T > &source)

Public Member Functions inherited from tvm::graph::abstract::Outputs
virtual	~Outputs ()=default

bool	isOutputEnabled (EnumT e) const

bool	isOutputEnabled (int i) const

virtual bool	isOutputStaticallyEnabled (int) const

virtual bool	isOutputCustomEnabled (int) const

Protected Member Functions
void	updateValue ()

void	updateVelocity ()

void	updateJacobian ()

void	updateNormalAcceleration ()

Protected Member Functions inherited from tvm::function::abstract::Function
	Function (int m=0)

	Function (Space image)

void	resizeCache () override

void	resizeVelocityCache ()

void	resizeNormalAccelerationCache ()

void	resizeJDotCache ()

void	addVariable_ (VariablePtr v) override

void	removeVariable_ (VariablePtr v) override

Protected Member Functions inherited from tvm::internal::FirstOrderProvider
	FirstOrderProvider (int m)

	FirstOrderProvider (Space image)

void	resizeValueCache ()

void	resizeJacobianCache ()

void	addVariable (VariablePtr v, bool linear)

void	removeVariable (VariablePtr v)

void	addVariable (const VariableVector &v, bool linear)

void	splitJacobian (const MatrixConstRef &J, const std::vector< VariablePtr > &vars, bool keepProperties=false)

void	splitJacobian (const MatrixConstRef &J, const VariableVector &vars, bool keepProperties=false)

void	resize (int m)

Protected Member Functions inherited from Node< FirstOrderProvider >
void	registerUpdates (EnumT u, void(U::*fn)(), Args... args)

void	registerUpdates (EnumT u, void(U::*fn)())

void	addOutputDependency (EnumO o, EnumU u)

void	addOutputDependency (std::initializer_list< EnumO > os, EnumU u)

void	addInternalDependency (EnumU1 uDependent, EnumU2 u)

void	addInputDependency (EnumU u, std::shared_ptr< S > source, EnumO i, Args... args)

void	addInputDependency (EnumU u, S &source, EnumO i, Args... args)

void	addDirectDependency (EnumO o, std::shared_ptr< S > source, EnumI i)

void	addDirectDependency (EnumO o, S &source, EnumI i)

Protected Attributes
mc_rbdyn::ConstRobotFramePtr	robot_frame_

mc_tvm::RobotFrame &	frame_

Eigen::Matrix3d	ori_

Eigen::Vector3d	refVel_

Eigen::Vector3d	refAccel_

Protected Attributes inherited from tvm::function::abstract::Function
Eigen::VectorXd	velocity_

Eigen::VectorXd	normalAcceleration_

utils::internal::MapWithVariableAsKey< Eigen::MatrixXd, slice_jdot >	JDot_

Protected Attributes inherited from tvm::internal::FirstOrderProvider
Eigen::VectorXd	value_

utils::internal::MapWithVariableAsKey< MatrixWithProperties, slice_matrix, true >	jacobian_

Space	imageSpace_

VariableVector	variables_

utils::internal::MapWithVariableAsKey< bool, slice_linear >	linear_

Protected Attributes inherited from tvm::graph::internal::AbstractNode
std::map< int, std::function< void(AbstractNode &)> >	updates_

std::map< int, std::vector< int > >	outputDependencies_

std::map< int, std::vector< int > >	internalDependencies_

std::map< int, input_dependency_t >	inputDependencies_

std::map< int, std::pair< Outputs *, int > >	directDependencies_

Protected Attributes inherited from tvm::graph::abstract::Outputs
bool	is_node_

Additional Inherited Members
Public Types inherited from tvm::graph::internal::AbstractNode
enum	Update_

typedef AbstractNode	UpdateParent

typedef AbstractNode	UpdateBase

Public Types inherited from tvm::graph::internal::Inputs
typedef std::unordered_map< abstract::Outputs *, std::set< int > >	inputs_t

typedef std::unordered_set< std::shared_ptr< abstract::Outputs > >	store_t

Public Types inherited from tvm::graph::abstract::Outputs
enum	Output_

typedef Outputs	OutputParent

typedef Outputs	OutputBase

Static Public Member Functions inherited from tvm::graph::internal::AbstractNode
static constexpr const char *	UpdateName (Update_)

static constexpr bool	UpdateStaticallyEnabled (EnumT)

Static Public Member Functions inherited from tvm::graph::abstract::Outputs
static constexpr const char *	OutputName (Output_)

static constexpr bool	OutputStaticallyEnabled (EnumT)

Static Public Attributes inherited from tvm::graph::internal::AbstractNode
static constexpr unsigned int	UpdateSize

static constexpr auto	UpdateBaseName

Static Public Attributes inherited from tvm::graph::abstract::Outputs
static constexpr unsigned int	OutputSize

static constexpr auto	OutputBaseName

Protected Types inherited from tvm::graph::internal::AbstractNode
typedef std::map< Outputs *, std::set< int > >	input_dependency_t

Detailed Description

This class implements an orientation function for a given frame

Constructor & Destructor Documentation

◆ OrientationFunction()

mc_tvm::OrientationFunction::OrientationFunction ( const mc_rbdyn::RobotFrame & frame )

Constructor

Set the objective to the current frame orientation

Member Function Documentation

◆ frame()

const mc_rbdyn::RobotFrame& mc_tvm::OrientationFunction::frame ( ) const

inlinenoexcept

Access the frame

◆ orientation() [1/2]

const Eigen::Matrix3d& mc_tvm::OrientationFunction::orientation ( ) const

inlinenoexcept

Get the current objective

◆ orientation() [2/2]

void mc_tvm::OrientationFunction::orientation ( const Eigen::Matrix3d & ori )

inlinenoexcept

Set the objective

◆ refAccel() [1/2]

const Eigen::Vector3d& mc_tvm::OrientationFunction::refAccel ( ) const

inlinenoexcept

Get the current objective

◆ refAccel() [2/2]

void mc_tvm::OrientationFunction::refAccel ( const Eigen::Vector3d & refAccel )

inlinenoexcept

Set the objective

◆ refVel() [1/2]

const Eigen::Vector3d& mc_tvm::OrientationFunction::refVel ( ) const

inlinenoexcept

Get the current objective

◆ refVel() [2/2]

void mc_tvm::OrientationFunction::refVel ( const Eigen::Vector3d & refVel )

inlinenoexcept

Set the objective

◆ reset()

void mc_tvm::OrientationFunction::reset ( )

Set the target orientation to the current frame orientation and reset reference velocity/acceleration to zero

◆ updateJacobian()

void mc_tvm::OrientationFunction::updateJacobian ( )

protected

◆ updateNormalAcceleration()

void mc_tvm::OrientationFunction::updateNormalAcceleration ( )

protected

◆ updateValue()

void mc_tvm::OrientationFunction::updateValue ( )

protected

◆ updateVelocity()

void mc_tvm::OrientationFunction::updateVelocity ( )

protected

Member Data Documentation

◆ frame_

mc_tvm::RobotFrame& mc_tvm::OrientationFunction::frame_

protected

◆ ori_

Eigen::Matrix3d mc_tvm::OrientationFunction::ori_

protected

Target

◆ refAccel_

Eigen::Vector3d mc_tvm::OrientationFunction::refAccel_

protected

◆ refVel_

Eigen::Vector3d mc_tvm::OrientationFunction::refVel_

protected

◆ robot_frame_

mc_rbdyn::ConstRobotFramePtr mc_tvm::OrientationFunction::robot_frame_

protected

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

include/mc_tvm/OrientationFunction.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OrientationFunction()

Member Function Documentation

◆ frame()

◆ orientation() [1/2]

◆ orientation() [2/2]

◆ refAccel() [1/2]

◆ refAccel() [2/2]

◆ refVel() [1/2]

◆ refVel() [2/2]

◆ reset()

◆ updateJacobian()

◆ updateNormalAcceleration()

◆ updateValue()

◆ updateVelocity()

Member Data Documentation

◆ frame_

◆ ori_

◆ refAccel_

◆ refVel_

◆ robot_frame_