Public Types | Public Member Functions | Public Attributes | Private Member Functions | Friends | List of all members
tesseract_common::JointTrajectory Class Reference

Represents a joint trajectory. More...

#include <joint_state.h>

Public Types

using const_iterator = typename std::vector< value_type >::const_iterator
 
using const_pointer = typename std::vector< value_type >::const_pointer
 
using const_reference = typename std::vector< value_type >::const_reference
 
using const_reverse_iterator = typename std::vector< value_type >::const_reverse_iterator
 
using difference_type = typename std::vector< value_type >::difference_type
 
using iterator = typename std::vector< value_type >::iterator
 
using pointer = typename std::vector< value_type >::pointer
 
using reference = typename std::vector< value_type >::reference
 
using reverse_iterator = typename std::vector< value_type >::reverse_iterator
 
using size_type = typename std::vector< value_type >::size_type
 
using value_type = JointState
 

Public Member Functions

reference at (size_type n)
 access specified element with bounds checking More...
 
const_reference at (size_type n) const
 access specified element with bounds checking More...
 
reference back ()
 access the last element More...
 
const_reference back () const
 access the last element More...
 
iterator begin ()
 returns an iterator to the beginning More...
 
const_iterator begin () const
 returns an iterator to the beginning More...
 
size_type capacity () const
 returns the number of elements that can be held in currently allocated storage More...
 
const_iterator cbegin () const
 returns an iterator to the beginning More...
 
const_iterator cend () const
 returns an iterator to the end More...
 
void clear ()
 clears the contents More...
 
const_reverse_iterator crbegin () const
 returns a reverse iterator to the beginning More...
 
const_reverse_iterator crend () const
 returns a reverse iterator to the end More...
 
pointer data ()
 direct access to the underlying array
More...
 
const_pointer data () const
 direct access to the underlying array
More...
 
template<class... Args>
iterator emplace (const_iterator pos, Args &&... args)
 constructs element in-place More...
 
template<typename... Args>
void emplace_back (Args &&... args)
 constructs an element in-place at the end
More...
 
bool empty () const
 checks whether the container is empty More...
 
iterator end ()
 returns an iterator to the end More...
 
const_iterator end () const
 returns an iterator to the end More...
 
iterator erase (const_iterator first, const_iterator last)
 
iterator erase (const_iterator p)
 erases element More...
 
reference front ()
 access the first element More...
 
const_reference front () const
 access the first element More...
 
iterator insert (const_iterator p, const value_type &x)
 inserts element More...
 
iterator insert (const_iterator p, std::initializer_list< value_type > l)
 
iterator insert (const_iterator p, value_type &&x)
 
template<class InputIt >
void insert (const_iterator pos, InputIt first, InputIt last)
 
template<class InputIt >
 JointTrajectory (InputIt first, InputIt last)
 
 JointTrajectory (std::string description="")
 
 JointTrajectory (std::vector< JointState > states, std::string description="")
 
size_type max_size () const
 returns the maximum possible number of elements More...
 
bool operator!= (const JointTrajectory &rhs) const
 
bool operator== (const JointTrajectory &other) const
 
reference operator[] (size_type pos)
 access specified element More...
 
const_reference operator[] (size_type pos) const
 access specified element More...
 
void pop_back ()
 removes the last element More...
 
void push_back (const value_type &&x)
 
void push_back (const value_type &x)
 adds an element to the end More...
 
reverse_iterator rbegin ()
 returns a reverse iterator to the beginning More...
 
const_reverse_iterator rbegin () const
 returns a reverse iterator to the beginning More...
 
reverse_iterator rend ()
 returns a reverse iterator to the end More...
 
const_reverse_iterator rend () const
 returns a reverse iterator to the end More...
 
void reserve (size_type n)
 reserve number of elements More...
 
void shrink_to_fit ()
 reduces memory usage by freeing unused memory
More...
 
size_type size () const
 returns the number of elements More...
 
void swap (std::vector< value_type > &other) noexcept
 swaps the contents
More...
 

Public Attributes

std::string description
 
std::vector< JointStatestates
 
boost::uuids::uuid uuid {}
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Friends

class boost::serialization::access
 
struct tesseract_common::Serialization
 

Detailed Description

Represents a joint trajectory.

Definition at line 85 of file joint_state.h.

Member Typedef Documentation

◆ const_iterator

const_iterator

Definition at line 120 of file joint_state.h.

◆ const_pointer

const_pointer

Definition at line 108 of file joint_state.h.

◆ const_reference

const_reference

Definition at line 112 of file joint_state.h.

◆ const_reverse_iterator

const_reverse_iterator

Definition at line 124 of file joint_state.h.

◆ difference_type

difference_type

Definition at line 116 of file joint_state.h.

◆ iterator

iterator

Definition at line 118 of file joint_state.h.

◆ pointer

pointer

Definition at line 106 of file joint_state.h.

◆ reference

reference

Definition at line 110 of file joint_state.h.

◆ reverse_iterator

reverse_iterator

Definition at line 122 of file joint_state.h.

◆ size_type

size_type

Definition at line 114 of file joint_state.h.

◆ value_type

value_type

Definition at line 104 of file joint_state.h.

Constructor & Destructor Documentation

◆ JointTrajectory() [1/3]

tesseract_common::JointTrajectory::JointTrajectory ( std::string  description = "")

Definition at line 73 of file joint_state.cpp.

◆ JointTrajectory() [2/3]

tesseract_common::JointTrajectory::JointTrajectory ( std::vector< JointState states,
std::string  description = "" 
)

Definition at line 75 of file joint_state.cpp.

◆ JointTrajectory() [3/3]

template<class InputIt >
tesseract_common::JointTrajectory::JointTrajectory ( InputIt  first,
InputIt  last 
)
inline

Definition at line 127 of file joint_state.h.

Member Function Documentation

◆ at() [1/2]

JointTrajectory::reference tesseract_common::JointTrajectory::at ( size_type  n)

access specified element with bounds checking

Definition at line 126 of file joint_state.cpp.

◆ at() [2/2]

JointTrajectory::const_reference tesseract_common::JointTrajectory::at ( size_type  n) const

access specified element with bounds checking

Definition at line 127 of file joint_state.cpp.

◆ back() [1/2]

JointTrajectory::const_reference tesseract_common::JointTrajectory::back ( )

access the last element

Definition at line 124 of file joint_state.cpp.

◆ back() [2/2]

const_reference tesseract_common::JointTrajectory::back ( ) const

access the last element

◆ begin() [1/2]

JointTrajectory::const_iterator tesseract_common::JointTrajectory::begin ( )

returns an iterator to the beginning

Definition at line 96 of file joint_state.cpp.

◆ begin() [2/2]

const_iterator tesseract_common::JointTrajectory::begin ( ) const

returns an iterator to the beginning

◆ capacity()

JointTrajectory::size_type tesseract_common::JointTrajectory::capacity ( ) const

returns the number of elements that can be held in currently allocated storage

Definition at line 116 of file joint_state.cpp.

◆ cbegin()

JointTrajectory::const_iterator tesseract_common::JointTrajectory::cbegin ( ) const

returns an iterator to the beginning

Definition at line 104 of file joint_state.cpp.

◆ cend()

JointTrajectory::const_iterator tesseract_common::JointTrajectory::cend ( ) const

returns an iterator to the end

Definition at line 105 of file joint_state.cpp.

◆ clear()

void tesseract_common::JointTrajectory::clear ( )

clears the contents

Definition at line 136 of file joint_state.cpp.

◆ crbegin()

JointTrajectory::const_reverse_iterator tesseract_common::JointTrajectory::crbegin ( ) const

returns a reverse iterator to the beginning

Definition at line 106 of file joint_state.cpp.

◆ crend()

JointTrajectory::const_reverse_iterator tesseract_common::JointTrajectory::crend ( ) const

returns a reverse iterator to the end

Definition at line 107 of file joint_state.cpp.

◆ data() [1/2]

JointTrajectory::const_pointer tesseract_common::JointTrajectory::data ( )

direct access to the underlying array

Definition at line 128 of file joint_state.cpp.

◆ data() [2/2]

const_pointer tesseract_common::JointTrajectory::data ( ) const

direct access to the underlying array

◆ emplace()

template<class... Args>
JointTrajectory::iterator tesseract_common::JointTrajectory::emplace ( const_iterator  pos,
Args &&...  args 
)

constructs element in-place

Definition at line 148 of file joint_state.cpp.

◆ emplace_back()

template<typename... Args>
void tesseract_common::JointTrajectory::emplace_back ( Args &&...  args)

constructs an element in-place at the end

Definition at line 168 of file joint_state.cpp.

◆ empty()

bool tesseract_common::JointTrajectory::empty ( ) const

checks whether the container is empty

Definition at line 112 of file joint_state.cpp.

◆ end() [1/2]

JointTrajectory::const_iterator tesseract_common::JointTrajectory::end ( )

returns an iterator to the end

Definition at line 98 of file joint_state.cpp.

◆ end() [2/2]

const_iterator tesseract_common::JointTrajectory::end ( ) const

returns an iterator to the end

◆ erase() [1/2]

JointTrajectory::iterator tesseract_common::JointTrajectory::erase ( const_iterator  first,
const_iterator  last 
)

Definition at line 154 of file joint_state.cpp.

◆ erase() [2/2]

JointTrajectory::iterator tesseract_common::JointTrajectory::erase ( const_iterator  p)

erases element

Definition at line 153 of file joint_state.cpp.

◆ front() [1/2]

JointTrajectory::const_reference tesseract_common::JointTrajectory::front ( )

access the first element

Definition at line 122 of file joint_state.cpp.

◆ front() [2/2]

const_reference tesseract_common::JointTrajectory::front ( ) const

access the first element

◆ insert() [1/4]

JointTrajectory::iterator tesseract_common::JointTrajectory::insert ( const_iterator  p,
const value_type x 
)

inserts element

Definition at line 137 of file joint_state.cpp.

◆ insert() [2/4]

JointTrajectory::iterator tesseract_common::JointTrajectory::insert ( const_iterator  p,
std::initializer_list< value_type l 
)

Definition at line 142 of file joint_state.cpp.

◆ insert() [3/4]

JointTrajectory::iterator tesseract_common::JointTrajectory::insert ( const_iterator  p,
value_type &&  x 
)

Definition at line 138 of file joint_state.cpp.

◆ insert() [4/4]

template<class InputIt >
void tesseract_common::JointTrajectory::insert ( const_iterator  pos,
InputIt  first,
InputIt  last 
)
inline

Definition at line 209 of file joint_state.h.

◆ max_size()

JointTrajectory::size_type tesseract_common::JointTrajectory::max_size ( ) const

returns the maximum possible number of elements

Definition at line 114 of file joint_state.cpp.

◆ operator!=()

bool tesseract_common::JointTrajectory::operator!= ( const JointTrajectory rhs) const

Definition at line 89 of file joint_state.cpp.

◆ operator==()

bool tesseract_common::JointTrajectory::operator== ( const JointTrajectory other) const

Definition at line 80 of file joint_state.cpp.

◆ operator[]() [1/2]

JointTrajectory::reference tesseract_common::JointTrajectory::operator[] ( size_type  pos)

access specified element

Definition at line 130 of file joint_state.cpp.

◆ operator[]() [2/2]

JointTrajectory::const_reference tesseract_common::JointTrajectory::operator[] ( size_type  pos) const

access specified element

Definition at line 131 of file joint_state.cpp.

◆ pop_back()

void tesseract_common::JointTrajectory::pop_back ( )

removes the last element

Definition at line 174 of file joint_state.cpp.

◆ push_back() [1/2]

void tesseract_common::JointTrajectory::push_back ( const value_type &&  x)

Definition at line 159 of file joint_state.cpp.

◆ push_back() [2/2]

void tesseract_common::JointTrajectory::push_back ( const value_type x)

adds an element to the end

Definition at line 158 of file joint_state.cpp.

◆ rbegin() [1/2]

JointTrajectory::const_reverse_iterator tesseract_common::JointTrajectory::rbegin ( )

returns a reverse iterator to the beginning

Definition at line 100 of file joint_state.cpp.

◆ rbegin() [2/2]

const_reverse_iterator tesseract_common::JointTrajectory::rbegin ( ) const

returns a reverse iterator to the beginning

◆ rend() [1/2]

JointTrajectory::const_reverse_iterator tesseract_common::JointTrajectory::rend ( )

returns a reverse iterator to the end

Definition at line 102 of file joint_state.cpp.

◆ rend() [2/2]

const_reverse_iterator tesseract_common::JointTrajectory::rend ( ) const

returns a reverse iterator to the end

◆ reserve()

void tesseract_common::JointTrajectory::reserve ( size_type  n)

reserve number of elements

Definition at line 115 of file joint_state.cpp.

◆ serialize()

template<class Archive >
void tesseract_common::JointTrajectory::serialize ( Archive &  ar,
const unsigned int  version 
)
private

Definition at line 180 of file joint_state.cpp.

◆ shrink_to_fit()

void tesseract_common::JointTrajectory::shrink_to_fit ( )

reduces memory usage by freeing unused memory

Definition at line 117 of file joint_state.cpp.

◆ size()

JointTrajectory::size_type tesseract_common::JointTrajectory::size ( ) const

returns the number of elements

Definition at line 113 of file joint_state.cpp.

◆ swap()

void tesseract_common::JointTrajectory::swap ( std::vector< value_type > &  other)
noexcept

swaps the contents

Definition at line 175 of file joint_state.cpp.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 239 of file joint_state.h.

◆ tesseract_common::Serialization

friend struct tesseract_common::Serialization
friend

Definition at line 240 of file joint_state.h.

Member Data Documentation

◆ description

std::string tesseract_common::JointTrajectory::description

Definition at line 93 of file joint_state.h.

◆ states

std::vector<JointState> tesseract_common::JointTrajectory::states

Definition at line 92 of file joint_state.h.

◆ uuid

boost::uuids::uuid tesseract_common::JointTrajectory::uuid {}

Definition at line 91 of file joint_state.h.


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


tesseract_common
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:01:40