Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::rigidbody::RotoTransNodes Class Reference

Hold a set of RotoTransNodes. More...

#include <RotoTransNodes.h>

Inheritance diagram for BIORBD_NAMESPACE::rigidbody::RotoTransNodes:
BIORBD_NAMESPACE::Model

Public Member Functions

 RotoTransNodes ()
 Construct RT set.
 RotoTransNodes (const RotoTransNodes &other)
 Construct RTs set from another set.
virtual ~RotoTransNodes ()
 Destroy the class properly.
RotoTransNodes DeepCopy () const
 Deep copy of the RTs data.
void DeepCopy (const RotoTransNodes &other)
 Deep copy the RTs data.
void addRT ()
 Add a new RT to the set.
virtual void addRT (const utils::RotoTransNode &RotoTrans)
 Add a new RT to the set.
size_t nbRTs () const
 Return the number of RTs in the set.
size_t size () const
 Return the number of RTs in the set.
std::vector< utils::String > RTsNames ()
 Return the names of the RTs.
const std::vector< utils::RotoTransNode > & RTs () const
 Return all the RTs in the local reference of the segment.
std::vector< utils::RotoTransNode > RTs (const utils::String &segmentName)
 Return all the RTs of a segment.
const utils::RotoTransNode & RT (size_t idx)
 Return the RTs of a specified index.
std::vector< utils::RotoTransNode > RTs (const GeneralizedCoordinates &Q, bool updateKin=true)
 Compute and return all the RTs at the position given by Q.
utils::RotoTransNode RT (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Compute and return the RT of index idx at the position given by Q.
std::vector< utils::RotoTransNode > segmentRTs (const GeneralizedCoordinates &Q, size_t idx, bool updateKin=true)
 Return all the RTs on a specified segment.
std::vector< utils::Matrix > RTsJacobian (const GeneralizedCoordinates &Q, bool updateKin=true)
 Return the jacobian of the RTs.
virtual void clear ()
 Return to an internal state similar to initial declaration.

Protected Attributes

std::shared_ptr< std::vector< utils::RotoTransNode > > m_RTs
 All the RTs.

Detailed Description

Hold a set of RotoTransNodes.

Definition at line 22 of file RotoTransNodes.h.

Constructor & Destructor Documentation

◆ RotoTransNodes() [1/2]

rigidbody::RotoTransNodes::RotoTransNodes ( )

Construct RT set.

Definition at line 18 of file RotoTransNodes.cpp.

◆ RotoTransNodes() [2/2]

rigidbody::RotoTransNodes::RotoTransNodes ( const RotoTransNodes & other)

Construct RTs set from another set.

Parameters
otherThe other RTs set

Definition at line 23 of file RotoTransNodes.cpp.

◆ ~RotoTransNodes()

rigidbody::RotoTransNodes::~RotoTransNodes ( )
virtual

Destroy the class properly.

Definition at line 28 of file RotoTransNodes.cpp.

Member Function Documentation

◆ addRT() [1/2]

void rigidbody::RotoTransNodes::addRT ( )

Add a new RT to the set.

Definition at line 44 of file RotoTransNodes.cpp.

◆ addRT() [2/2]

void rigidbody::RotoTransNodes::addRT ( const utils::RotoTransNode & RotoTrans)
virtual

Add a new RT to the set.

Parameters
RotoTransThe RotaTrans of the RT

Definition at line 49 of file RotoTransNodes.cpp.

◆ clear()

void rigidbody::RotoTransNodes::clear ( )
virtual

Return to an internal state similar to initial declaration.

Definition at line 159 of file RotoTransNodes.cpp.

◆ DeepCopy() [1/2]

rigidbody::RotoTransNodes rigidbody::RotoTransNodes::DeepCopy ( ) const

Deep copy of the RTs data.

Returns
A copy of the RTs data

Definition at line 30 of file RotoTransNodes.cpp.

◆ DeepCopy() [2/2]

void rigidbody::RotoTransNodes::DeepCopy ( const RotoTransNodes & other)

Deep copy the RTs data.

Parameters
otherThe RT data to copy

Definition at line 36 of file RotoTransNodes.cpp.

◆ nbRTs()

size_t rigidbody::RotoTransNodes::nbRTs ( ) const

Return the number of RTs in the set.

Returns
The number of RTs

Definition at line 53 of file RotoTransNodes.cpp.

◆ RT() [1/2]

utils::RotoTransNode rigidbody::RotoTransNodes::RT ( const GeneralizedCoordinates & Q,
size_t idx,
bool updateKin = true )

Compute and return the RT of index idx at the position given by Q.

Parameters
QThe generalized coordinates
idxThe index of the RT in the set
updateKinIf the model should be updated
Returns
The RT of index idx at the position given by Q

Definition at line 92 of file RotoTransNodes.cpp.

◆ RT() [2/2]

const utils::RotoTransNode & rigidbody::RotoTransNodes::RT ( size_t idx)

Return the RTs of a specified index.

Parameters
idxThe index of the RT in the set
Returns
RT of idx i

Definition at line 74 of file RotoTransNodes.cpp.

◆ RTs() [1/3]

const std::vector< utils::RotoTransNode > & rigidbody::RotoTransNodes::RTs ( ) const

Return all the RTs in the local reference of the segment.

Returns
All the RTs in local reference frame

Definition at line 58 of file RotoTransNodes.cpp.

◆ RTs() [2/3]

std::vector< utils::RotoTransNode > rigidbody::RotoTransNodes::RTs ( const GeneralizedCoordinates & Q,
bool updateKin = true )

Compute and return all the RTs at the position given by Q.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
Returns
All the RTs at the position given by Q

Definition at line 79 of file RotoTransNodes.cpp.

◆ RTs() [3/3]

std::vector< utils::RotoTransNode > rigidbody::RotoTransNodes::RTs ( const utils::String & segmentName)

Return all the RTs of a segment.

Parameters
segmentNameThe name of the segment to return the RTs
Returns
All the RTs of attached to the segment

Definition at line 63 of file RotoTransNodes.cpp.

◆ RTsJacobian()

std::vector< utils::Matrix > rigidbody::RotoTransNodes::RTsJacobian ( const GeneralizedCoordinates & Q,
bool updateKin = true )

Return the jacobian of the RTs.

Parameters
QThe generalized coordinates
updateKinIf the model should be updated
Returns
The jacobien of the RTs

Definition at line 125 of file RotoTransNodes.cpp.

◆ RTsNames()

std::vector< utils::String > rigidbody::RotoTransNodes::RTsNames ( )

Return the names of the RTs.

Returns
The names of the RTs

Definition at line 150 of file RotoTransNodes.cpp.

◆ segmentRTs()

std::vector< utils::RotoTransNode > rigidbody::RotoTransNodes::segmentRTs ( const GeneralizedCoordinates & Q,
size_t idx,
bool updateKin = true )

Return all the RTs on a specified segment.

Parameters
QThe generalized coordinates
idxThe index of the segment
updateKinIf the model should be updated
Returns
All the RTs on the segment of index idx

Definition at line 103 of file RotoTransNodes.cpp.

◆ size()

size_t rigidbody::RotoTransNodes::size ( ) const

Return the number of RTs in the set.

Returns
The number of RTs

Definition at line 55 of file RotoTransNodes.cpp.

Member Data Documentation

◆ m_RTs

std::shared_ptr<std::vector<utils::RotoTransNode> > BIORBD_NAMESPACE::rigidbody::RotoTransNodes::m_RTs
protected

All the RTs.

Definition at line 148 of file RotoTransNodes.h.


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