Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
descartes_core::TrajectoryID_< T > Class Template Reference

TrajectoryID_ represents a unique id to be associated with a TrajectoryPt. More...

#include <trajectory_id.h>

List of all members.

Public Types

typedef T value_type

Public Member Functions

bool is_nil () const
 Tests if this ID is nil.
 TrajectoryID_ (value_type id)
 Constructor for generating a trajectory id using the given state object.
 TrajectoryID_ ()
 Constructor for generating a trajectory with a default id. Here we default the points to nil. Default constructor is needed for STL containers.
value_type value () const
 Retrieves the value of the underlying id state object.

Static Public Member Functions

static TrajectoryID_< value_typemake_id ()
 Factory function to generate a trajectory ID with a unique state object.
static TrajectoryID_< value_typemake_nil ()
 Factory function to generate a trajectory ID with a nil state object.

Private Attributes

value_type id_

Detailed Description

template<typename T>
class descartes_core::TrajectoryID_< T >

TrajectoryID_ represents a unique id to be associated with a TrajectoryPt.

Definition at line 61 of file trajectory_id.h.


Member Typedef Documentation

template<typename T>
typedef T descartes_core::TrajectoryID_< T >::value_type

Definition at line 64 of file trajectory_id.h.


Constructor & Destructor Documentation

template<typename T>
descartes_core::TrajectoryID_< T >::TrajectoryID_ ( value_type  id) [inline]

Constructor for generating a trajectory id using the given state object.

Definition at line 69 of file trajectory_id.h.

template<typename T>
descartes_core::TrajectoryID_< T >::TrajectoryID_ ( ) [inline]

Constructor for generating a trajectory with a default id. Here we default the points to nil. Default constructor is needed for STL containers.

Definition at line 77 of file trajectory_id.h.


Member Function Documentation

template<typename T>
bool descartes_core::TrajectoryID_< T >::is_nil ( ) const [inline]

Tests if this ID is nil.

Definition at line 84 of file trajectory_id.h.

template<typename T>
static TrajectoryID_<value_type> descartes_core::TrajectoryID_< T >::make_id ( ) [inline, static]

Factory function to generate a trajectory ID with a unique state object.

Definition at line 100 of file trajectory_id.h.

template<typename T>
static TrajectoryID_<value_type> descartes_core::TrajectoryID_< T >::make_nil ( ) [inline, static]

Factory function to generate a trajectory ID with a nil state object.

Definition at line 108 of file trajectory_id.h.

template<typename T>
value_type descartes_core::TrajectoryID_< T >::value ( ) const [inline]

Retrieves the value of the underlying id state object.

Definition at line 92 of file trajectory_id.h.


Member Data Documentation

template<typename T>
value_type descartes_core::TrajectoryID_< T >::id_ [private]

Definition at line 114 of file trajectory_id.h.


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


descartes_core
Author(s): Dan Solomon
autogenerated on Thu Jun 6 2019 21:35:59