Public Member Functions | Public Attributes
descartes_core::TimingConstraint Struct Reference

A window of time for this point to be achieved relative to a previous point or the starting position. More...

#include <trajectory_timing_constraint.h>

List of all members.

Public Member Functions

bool isSpecified () const
 Checks if the given timing constraint has been specified.
 TimingConstraint ()
 The default constructor creates an unspecified point.
 TimingConstraint (double nominal)
 Constructs a timing constraint with a nominal time value (window width of zero)
 TimingConstraint (double lower, double upper)
 Constructs a timing constraint using the provided time window.

Public Attributes

double lower
double upper

Detailed Description

A window of time for this point to be achieved relative to a previous point or the starting position.

This struct defines a 'lower' and 'upper' bound for the desired time. If the upper bound is zero or negative, it is considered unspecified and the behavior of your planner or filter is considered undefined.

All time-value units are in seconds.

Definition at line 42 of file trajectory_timing_constraint.h.


Constructor & Destructor Documentation

The default constructor creates an unspecified point.

Definition at line 47 of file trajectory_timing_constraint.h.

descartes_core::TimingConstraint::TimingConstraint ( double  nominal) [inline, explicit]

Constructs a timing constraint with a nominal time value (window width of zero)

Parameters:
nominalThe desired time in seconds to achieve this point from the previous

Definition at line 56 of file trajectory_timing_constraint.h.

descartes_core::TimingConstraint::TimingConstraint ( double  lower,
double  upper 
) [inline]

Constructs a timing constraint using the provided time window.

Parameters:
lowerThe lower bound of the acceptable time window in seconds.
upperThe upper bound of the acceptable time window in seconds.

Definition at line 73 of file trajectory_timing_constraint.h.


Member Function Documentation

Checks if the given timing constraint has been specified.

Returns:
true if the point is specified

Definition at line 94 of file trajectory_timing_constraint.h.


Member Data Documentation

Definition at line 96 of file trajectory_timing_constraint.h.

Definition at line 96 of file trajectory_timing_constraint.h.


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


descartes_core
Author(s): Dan Solomon
autogenerated on Wed Aug 26 2015 11:21:21