Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::utils::Vector2d Class Reference

Wrapper around Eigen Vector2d and attach it to a parent. More...

#include <Vector2d.h>

Inheritance diagram for BIORBD_NAMESPACE::utils::Vector2d:
BIORBD_NAMESPACE::utils::Node

Public Member Functions

 Vector2d ()
 Construct 2D vector.
 Vector2d (const Scalar &x, const Scalar &y)
 Construct 2D vector.
 Vector2d (const Scalar &x, const Scalar &y, const String &name, const String &parentName)
 Construct a 2D vector.
 Vector2d (const Vector2d vec, const String &name, const String &parentName)
 Construct a 2D vector.
 Vector2d (const RigidBodyDynamics::Math::Vector2d &other)
 Construct a 2D vector from a Casadi 2D vector (drop the trailling 1).
 Vector2d (const RigidBodyDynamics::Math::VectorNd &other)
 Construct a 2D vector from a Casadi ND vector (drop the trailling 1).
Vector2d DeepCopy () const
 Deep copy of a 2D vector.
void DeepCopy (const Vector2d &other)
 Deep copy of a 2D vector into another 2D vector.
void setPosition (const Vector2d &v)
 Set a new position.
Public Member Functions inherited from BIORBD_NAMESPACE::utils::Node
 Node ()
 Construct Node.
 Node (const Node &other)
 Construct Node from another node.
 Node (const String &name)
 Construct Node.
 Node (const String &name, const String &parentName)
 Construct Node.
virtual ~Node ()
 Destroy class properly.
void DeepCopy (const Node &other)
 Deep copy of the node in another node.
void setName (const String &name)
 Set the name of the node.
const String & name () const
 Return the name of the node.
const String & parent () const
 Return the parent name of the node.
void setParent (const String &name)
 Set the parent name of the node.
NODE_TYPE typeOfNode () const
 Return the type of node.

Protected Member Functions

void setType ()
 Set the type Vector2d.

Additional Inherited Members

Protected Attributes inherited from BIORBD_NAMESPACE::utils::Node
std::shared_ptr< String > m_name
 The name of the node.
std::shared_ptr< String > m_parentName
 The parent name of the node.
std::shared_ptr< NODE_TYPE > m_typeOfNode
 The type of the node.

Detailed Description

Wrapper around Eigen Vector2d and attach it to a parent.

Definition at line 24 of file Vector2d.h.

Constructor & Destructor Documentation

◆ Vector2d() [1/6]

utils::Vector2d::Vector2d ( )

Construct 2D vector.

Definition at line 9 of file Vector2d.cpp.

◆ Vector2d() [2/6]

utils::Vector2d::Vector2d ( const Scalar & x,
const Scalar & y )

Construct 2D vector.

Parameters
xX-Component of the vector
yY-Component of the vector

Definition at line 16 of file Vector2d.cpp.

◆ Vector2d() [3/6]

utils::Vector2d::Vector2d ( const Scalar & x,
const Scalar & y,
const String & name,
const String & parentName )

Construct a 2D vector.

Parameters
xX-Component of the vector
yY-Component of the vector
nameName of the vector
parentNameName of the parent segment

Definition at line 21 of file Vector2d.cpp.

◆ Vector2d() [4/6]

utils::Vector2d::Vector2d ( const Vector2d vec,
const String & name,
const String & parentName )

Construct a 2D vector.

Parameters
vecThe vector to copy
nameName of the vector
parentNameName of the parent segment

Definition at line 30 of file Vector2d.cpp.

◆ Vector2d() [5/6]

utils::Vector2d::Vector2d ( const RigidBodyDynamics::Math::Vector2d & other)

Construct a 2D vector from a Casadi 2D vector (drop the trailling 1).

Parameters
otherThe Casadi 2D vector

Definition at line 36 of file Vector2d.cpp.

◆ Vector2d() [6/6]

utils::Vector2d::Vector2d ( const RigidBodyDynamics::Math::VectorNd & other)

Construct a 2D vector from a Casadi ND vector (drop the trailling 1).

Parameters
otherThe Casadi ND vector

Definition at line 41 of file Vector2d.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

utils::Vector2d utils::Vector2d::DeepCopy ( ) const

Deep copy of a 2D vector.

Returns
A deep copy of a 2D vector

Definition at line 55 of file Vector2d.cpp.

◆ DeepCopy() [2/2]

void utils::Vector2d::DeepCopy ( const Vector2d & other)

Deep copy of a 2D vector into another 2D vector.

Parameters
otherThe 2D vector to copy

Definition at line 61 of file Vector2d.cpp.

◆ setPosition()

void utils::Vector2d::setPosition ( const Vector2d & v)

Set a new position.

Parameters
vThe new position

Definition at line 66 of file Vector2d.cpp.

◆ setType()

void utils::Vector2d::setType ( )
protectedvirtual

Set the type Vector2d.

Implements BIORBD_NAMESPACE::utils::Node.

Definition at line 75 of file Vector2d.cpp.


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