Vanetza
 
Loading...
Searching...
No Matches
vanetza::facilities::PathHistory Class Reference

#include <path_history.hpp>

Public Member Functions

void addSample (const PathPoint &)
 
const PathPointgetReferencePoint () const
 
const std::list< PathPoint > & getConcisePoints () const
 

Private Member Functions

void updateConcisePoints ()
 
void truncateConcisePoints ()
 
const PathPointstarting () const
 
const PathPointprevious () const
 
const PathPointnext () const
 

Private Attributes

boost::circular_buffer< PathPointm_samples
 
std::list< PathPointm_concise
 

Detailed Description

Implementation of Path History Reference Design (Method One)

See also
NHTSA Document "VSC-A Final Report: Appendix B-2" from September 2011

Definition at line 17 of file path_history.hpp.

Constructor & Destructor Documentation

◆ PathHistory()

vanetza::facilities::PathHistory::PathHistory ( )

Definition at line 16 of file path_history.cpp.

Member Function Documentation

◆ addSample()

void vanetza::facilities::PathHistory::addSample ( const PathPoint point)

Consider one further path point for inclusion into path history

Parameters
apath point, expected to be newer than any previously given point

Definition at line 39 of file path_history.cpp.

◆ getConcisePoints()

const std::list< PathPoint > & vanetza::facilities::PathHistory::getConcisePoints ( ) const
inline

Get concise list of path points

Note
previously given path points are only included if the algorithm presented in above mentioned document as "Method One" selects them
Returns
list of path points, some given points might be omitted

Definition at line 40 of file path_history.hpp.

◆ getReferencePoint()

const PathPoint & vanetza::facilities::PathHistory::getReferencePoint ( ) const

Get current reference point, i.e. last provided path point

Returns
current reference point (fallback is a default constructed PathPoint)

Definition at line 50 of file path_history.cpp.

◆ next()

const PathPoint & vanetza::facilities::PathHistory::next ( ) const
private

Definition at line 33 of file path_history.cpp.

◆ previous()

const PathPoint & vanetza::facilities::PathHistory::previous ( ) const
private

Definition at line 27 of file path_history.cpp.

◆ starting()

const PathPoint & vanetza::facilities::PathHistory::starting ( ) const
private

Definition at line 21 of file path_history.cpp.

◆ truncateConcisePoints()

void vanetza::facilities::PathHistory::truncateConcisePoints ( )
private

Definition at line 87 of file path_history.cpp.

◆ updateConcisePoints()

void vanetza::facilities::PathHistory::updateConcisePoints ( )
private

Definition at line 61 of file path_history.cpp.

Member Data Documentation

◆ m_concise

std::list<PathPoint> vanetza::facilities::PathHistory::m_concise
private

Definition at line 50 of file path_history.hpp.

◆ m_samples

boost::circular_buffer<PathPoint> vanetza::facilities::PathHistory::m_samples
private

Definition at line 49 of file path_history.hpp.


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