KDL::Chain Class Reference

This class encapsulates a serial kinematic interconnection structure. It is built out of segments. More...

#include <chain.hpp>

Public Member Functions
void	addChain (const Chain &chain)
void	addSegment (const Segment &segment)
	Chain ()
	Chain (const Chain &in)
unsigned int	getNrOfJoints () const
unsigned int	getNrOfSegments () const
Segment &	getSegment (unsigned int nr)
const Segment &	getSegment (unsigned int nr) const
Chain &	operator= (const Chain &arg)
virtual	~Chain ()

Public Attributes
std::vector< Segment >	segments

Private Attributes
unsigned int	nrOfJoints
unsigned int	nrOfSegments

Detailed Description

This class encapsulates a serial kinematic interconnection structure. It is built out of segments.

Definition at line 35 of file chain.hpp.

Constructor & Destructor Documentation

Chain() [1/2]

KDL::Chain::Chain

(

)

The constructor of a chain, a new chain is always empty.

Definition at line 26 of file chain.cpp.

Chain() [2/2]

KDL::Chain::Chain

(

const Chain &

in

)

Definition at line 33 of file chain.cpp.

~Chain()

KDL::Chain::~Chain ( )

virtual

Definition at line 77 of file chain.cpp.

Member Function Documentation

addChain()

void KDL::Chain::addChain

(

const Chain &

chain

)

Adds a complete chain to the end of the chain The added chain is copied.

Parameters

chain

The chain to add

Definition at line 61 of file chain.cpp.

addSegment()

void KDL::Chain::addSegment

(

const Segment &

segment

)

Adds a new segment to the end of the chain.

Parameters

segment

The segment to add

Definition at line 53 of file chain.cpp.

getNrOfJoints()

unsigned int KDL::Chain::getNrOfJoints ( ) const

inline

Request the total number of joints in the chain.
Important: It is not the same as the total number of segments since a segment does not need to have a joint. This function is important when creating a KDL::JntArray to use with this chain.

Returns

total nr of joints

Definition at line 71 of file chain.hpp.

getNrOfSegments()

unsigned int KDL::Chain::getNrOfSegments ( ) const

inline

Request the total number of segments in the chain.

Returns

total number of segments

Definition at line 76 of file chain.hpp.

getSegment() [1/2]

Segment & KDL::Chain::getSegment

(

unsigned int

nr

)

Request the nr'd segment of the chain. There is no boundary checking.

Parameters

nr	the nr of the segment starting from 0

Returns

a reference to the nr'd segment

Definition at line 72 of file chain.cpp.

getSegment() [2/2]

const Segment & KDL::Chain::getSegment

(

unsigned int

nr

)

const

Request the nr'd segment of the chain. There is no boundary checking.

Parameters

nr	the nr of the segment starting from 0

Returns

a constant reference to the nr'd segment

Definition at line 67 of file chain.cpp.

operator=()

Chain & KDL::Chain::operator=

(

const Chain &

arg

)

Definition at line 42 of file chain.cpp.

Member Data Documentation

nrOfJoints

unsigned int KDL::Chain::nrOfJoints

private

Definition at line 37 of file chain.hpp.

nrOfSegments

unsigned int KDL::Chain::nrOfSegments

private

Definition at line 38 of file chain.hpp.

segments

std::vector<Segment> KDL::Chain::segments

Definition at line 40 of file chain.hpp.

---

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

• chain.hpp
• chain.cpp