NASA Astrobee Robot Software  0.19.1
Flight software for the Astrobee robots operating inside the International Space Station.
localization_common::TimestampedSet< T > Class Template Reference

#include <timestamped_set.h>

Inheritance diagram for localization_common::TimestampedSet< T >:
Inheritance graph

Public Member Functions

 TimestampedSet (const boost::optional< int > max_size=boost::none)
 
 ~TimestampedSet ()=default
 
 TimestampedSet (const std::vector< Time > &timestamps, const std::vector< T > &values, const boost::optional< int > max_size=boost::none)
 
bool Add (const Time timestamp, const T &value)
 
bool Remove (const Time timestamp)
 
boost::optional< TimestampedValue< T > > Get (const Time timestamp) const
 
size_t size () const
 
bool empty () const
 
void Clear ()
 
boost::optional< TimestampedValue< T > > Oldest () const
 
boost::optional< TimeOldestTimestamp () const
 
boost::optional< TimestampedValue< T > > Latest () const
 
boost::optional< TimeLatestTimestamp () const
 
bool WithinBounds (const Time timestamp) const
 
std::pair< boost::optional< TimestampedValue< T > >, boost::optional< TimestampedValue< T > > > LowerAndUpperBound (const Time timestamp) const
 
boost::optional< TimestampedValue< T > > Closest (const Time timestamp) const
 
boost::optional< TimestampedValue< T > > LowerBoundOrEqual (const Time timestamp) const
 
std::vector< TimeTimestamps () const
 
double Duration () const
 
bool Contains (const Time timestamp) const
 
std::vector< TimestampedValue< T > > LatestValues (const Time oldest_allowed_timestamp) const
 
std::vector< TimestampedValue< T > > OldValues (const Time oldest_allowed_timestamp) const
 
template<typename TimestampSetType >
std::vector< TimestampedValue< T > > DownsampledValues (const TimestampSetType &allowed_timestamps) const
 
int RemoveOldValues (const Time oldest_allowed_timestamp)
 
int RemoveBelowLowerBoundValues (const Time timestamp)
 
boost::optional< TimestampedValue< T > > RemoveOldest ()
 
const std::map< Time, T > & set () const
 
std::map< Time, T > & set ()
 
std::map< Time, T >::const_iterator cend () const
 
std::pair< typename std::map< Time, T >::const_iterator, typename std::map< Time, T >::const_iterator > InRangeValues (const Time oldest_allowed_timestamp, const Time latest_allowed_timestamp)
 

Friends

class boost::serialization::access
 

Constructor & Destructor Documentation

◆ TimestampedSet() [1/2]

template<typename T >
localization_common::TimestampedSet< T >::TimestampedSet ( const boost::optional< int >  max_size = boost::none)
explicit

◆ ~TimestampedSet()

template<typename T >
localization_common::TimestampedSet< T >::~TimestampedSet ( )
default

◆ TimestampedSet() [2/2]

template<typename T >
localization_common::TimestampedSet< T >::TimestampedSet ( const std::vector< Time > &  timestamps,
const std::vector< T > &  values,
const boost::optional< int >  max_size = boost::none 
)

Member Function Documentation

◆ Add()

template<typename T >
bool localization_common::TimestampedSet< T >::Add ( const Time  timestamp,
const T &  value 
)

◆ cend()

template<typename T >
std::map< Time, T >::const_iterator localization_common::TimestampedSet< T >::cend

◆ Clear()

template<typename T >
void localization_common::TimestampedSet< T >::Clear

◆ Closest()

template<typename T >
boost::optional< TimestampedValue< T > > localization_common::TimestampedSet< T >::Closest ( const Time  timestamp) const

◆ Contains()

template<typename T >
bool localization_common::TimestampedSet< T >::Contains ( const Time  timestamp) const

◆ DownsampledValues()

template<typename T >
template<typename TimestampSetType >
std::vector< TimestampedValue< T > > localization_common::TimestampedSet< T >::DownsampledValues ( const TimestampSetType &  allowed_timestamps) const

◆ Duration()

template<typename T >
double localization_common::TimestampedSet< T >::Duration

◆ empty()

template<typename T >
bool localization_common::TimestampedSet< T >::empty

◆ Get()

template<typename T >
boost::optional< TimestampedValue< T > > localization_common::TimestampedSet< T >::Get ( const Time  timestamp) const

◆ InRangeValues()

template<typename T >
std::pair< typename std::map< Time, T >::const_iterator, typename std::map< Time, T >::const_iterator > localization_common::TimestampedSet< T >::InRangeValues ( const Time  oldest_allowed_timestamp,
const Time  latest_allowed_timestamp 
)

◆ Latest()

template<typename T >
boost::optional< TimestampedValue< T > > localization_common::TimestampedSet< T >::Latest

◆ LatestTimestamp()

template<typename T >
boost::optional< Time > localization_common::TimestampedSet< T >::LatestTimestamp

◆ LatestValues()

template<typename T >
std::vector< TimestampedValue< T > > localization_common::TimestampedSet< T >::LatestValues ( const Time  oldest_allowed_timestamp) const

◆ LowerAndUpperBound()

template<typename T >
std::pair< boost::optional< TimestampedValue< T > >, boost::optional< TimestampedValue< T > > > localization_common::TimestampedSet< T >::LowerAndUpperBound ( const Time  timestamp) const

◆ LowerBoundOrEqual()

template<typename T >
boost::optional< TimestampedValue< T > > localization_common::TimestampedSet< T >::LowerBoundOrEqual ( const Time  timestamp) const

◆ Oldest()

template<typename T >
boost::optional< TimestampedValue< T > > localization_common::TimestampedSet< T >::Oldest

◆ OldestTimestamp()

template<typename T >
boost::optional< Time > localization_common::TimestampedSet< T >::OldestTimestamp

◆ OldValues()

template<typename T >
std::vector< TimestampedValue< T > > localization_common::TimestampedSet< T >::OldValues ( const Time  oldest_allowed_timestamp) const

◆ Remove()

template<typename T >
bool localization_common::TimestampedSet< T >::Remove ( const Time  timestamp)

◆ RemoveBelowLowerBoundValues()

template<typename T >
int localization_common::TimestampedSet< T >::RemoveBelowLowerBoundValues ( const Time  timestamp)

◆ RemoveOldest()

template<typename T >
boost::optional< TimestampedValue< T > > localization_common::TimestampedSet< T >::RemoveOldest

◆ RemoveOldValues()

template<typename T >
int localization_common::TimestampedSet< T >::RemoveOldValues ( const Time  oldest_allowed_timestamp)

◆ set() [1/2]

template<typename T >
std::map<Time, T>& localization_common::TimestampedSet< T >::set ( )

◆ set() [2/2]

template<typename T >
std::map< Time, T > & localization_common::TimestampedSet< T >::set

◆ size()

template<typename T >
size_t localization_common::TimestampedSet< T >::size

◆ Timestamps()

template<typename T >
std::vector< Time > localization_common::TimestampedSet< T >::Timestamps

◆ WithinBounds()

template<typename T >
bool localization_common::TimestampedSet< T >::WithinBounds ( const Time  timestamp) const

Friends And Related Function Documentation

◆ boost::serialization::access

template<typename T >
friend class boost::serialization::access
friend

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