base::JointLimitRange Struct Reference

#include <JointLimitRange.hpp>

Classes
struct	OutOfBounds

Public Member Functions
void	validate (const JointState &state) const
bool	isValid (const JointState &state) const

Static Public Member Functions
static JointLimitRange	Position (double min, double max)
static JointLimitRange	Speed (double min, double max)
static JointLimitRange	Effort (double min, double max)
static JointLimitRange	Raw (double min, double max)
static JointLimitRange	Acceleration (double min, double max)

Public Attributes
JointState	min
JointState	max

Member Function Documentation

Acceleration()

JointLimitRange base::JointLimitRange::Acceleration ( double  min, double  max  )

static

Creates a JointLimitRange structure with the acceleration range set to min, max

Effort()

JointLimitRange base::JointLimitRange::Effort ( double  min, double  max  )

static

Creates a JointLimitRange structure with the effort range set to min, max

isValid()

bool base::JointLimitRange::isValid

(

const JointState &

state

)

const

Checks that the provided JointState is within limits for the values that are valid

Returns

true if the check passes, false otherwise

Position()

JointLimitRange base::JointLimitRange::Position ( double  min, double  max  )

static

Creates a JointLimitRange structure with the position range set to min, max

Raw()

JointLimitRange base::JointLimitRange::Raw ( double  min, double  max  )

static

Creates a JointLimitRange structure with the raw range set to min, max

Speed()

JointLimitRange base::JointLimitRange::Speed ( double  min, double  max  )

static

Creates a JointLimitRange structure with the speed range set to min, max

validate()

void base::JointLimitRange::validate

(

const JointState &

state

)

const

Checks that the provided JointState is within limits for the values that are valid

Exceptions

OutOfBoundsException

if limits are exceeded.

Member Data Documentation

max

JointState base::JointLimitRange::max

min

JointState base::JointLimitRange::min

---

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

• /home/dfki.uni-bremen.de/roehr/workspace/2maz/dev/base/types/src/JointLimitRange.hpp
• /home/dfki.uni-bremen.de/roehr/workspace/2maz/dev/base/types/src/JointLimitRange.cpp