teb_local_planner::VertexTimeDiff Class Reference

This class stores and wraps a time difference into a vertex that can be optimized via g2o. More...

#include <vertex_timediff.h>

List of all members.

Public Member Functions
double &	dt ()
	Access the timediff value of the vertex.
const double &	dt () const
	Access the timediff value of the vertex (read-only)
virtual void	oplusImpl (const double *update)
	Define the update increment . A simple addition implements what we want.
virtual bool	read (std::istream &is)
	Read an estimate of from an input stream.
virtual void	setToOriginImpl ()
	Set the underlying TimeDiff estimate to default.
	VertexTimeDiff (bool fixed=false)
	Default constructor.
	VertexTimeDiff (double dt, bool fixed=false)
	Construct the TimeDiff vertex with a value.
virtual bool	write (std::ostream &os) const
	Write the estimate to an output stream.
	~VertexTimeDiff ()
	Destructs the VertexTimeDiff.

---

Detailed Description

This class stores and wraps a time difference into a vertex that can be optimized via g2o.

See also:

VertexPointXY

VertexOrientation

Definition at line 65 of file vertex_timediff.h.

---

Constructor & Destructor Documentation

teb_local_planner::VertexTimeDiff::VertexTimeDiff

(

bool

fixed = false

)

[inline]

Default constructor.

Parameters:

fixed

if true, this vertex is considered fixed during optimization [default: false]

Definition at line 73 of file vertex_timediff.h.

teb_local_planner::VertexTimeDiff::VertexTimeDiff	(	double	dt,
		bool	fixed = false
	)		[inline]

Construct the TimeDiff vertex with a value.

Parameters:

dt	time difference value of the vertex
fixed	if true, this vertex is considered fixed during optimization [default: false]

Definition at line 84 of file vertex_timediff.h.

teb_local_planner::VertexTimeDiff::~VertexTimeDiff

(

)

[inline]

Destructs the VertexTimeDiff.

Definition at line 93 of file vertex_timediff.h.

---

Member Function Documentation

double& teb_local_planner::VertexTimeDiff::dt

(

)

[inline]

Access the timediff value of the vertex.

See also:

estimate

Returns:

reference to dt

Definition at line 101 of file vertex_timediff.h.

const double& teb_local_planner::VertexTimeDiff::dt

(

)

const [inline]

Access the timediff value of the vertex (read-only)

See also:

estimate

Returns:

const reference to dt

Definition at line 108 of file vertex_timediff.h.

virtual void teb_local_planner::VertexTimeDiff::oplusImpl

(

const double *

update

)

[inline, virtual]

Define the update increment . A simple addition implements what we want.

Parameters:

update

increment that should be added to the previous esimate

Definition at line 123 of file vertex_timediff.h.

virtual bool teb_local_planner::VertexTimeDiff::read

(

std::istream &

is

)

[inline, virtual]

Read an estimate of from an input stream.

Parameters:

is	input stream

Returns:

always true

Definition at line 133 of file vertex_timediff.h.

virtual void teb_local_planner::VertexTimeDiff::setToOriginImpl

(

)

[inline, virtual]

Set the underlying TimeDiff estimate to default.

Definition at line 113 of file vertex_timediff.h.

virtual bool teb_local_planner::VertexTimeDiff::write

(

std::ostream &

os

)

const [inline, virtual]

Write the estimate to an output stream.

Parameters:

os	output stream

Returns:

true if the export was successful, otherwise false

Definition at line 144 of file vertex_timediff.h.

---

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

• vertex_timediff.h