corbo::TimeSeriesSequence Class Reference

Sequence of time series objects. More...

#include <time_series.h>

Public Types
using	ConstPtr = std::shared_ptr< const TimeSeriesSequence >
using	Ptr = std::shared_ptr< TimeSeriesSequence >

Public Member Functions
bool	add (TimeSeries::Ptr ts)
	Add shared instance of a time series (without copying) More...
void	clear ()
	Erase all time series. More...
const std::vector< TimeSeries::Ptr > &	getSequence () const
	Read access to the underlying sequence of time series (shared instances) More...
int	getValueDimension () const
	Return dimension of the value vector. More...
bool	isEmpty () const
	Determine if no time series is available. More...
void	setValueDimension (int value_dim)
	Change value dimension (warning: clears existing values) More...
void	sortByTimeFromStart ()
	Ascending sort of the time series objects according to their TimeSeries::timeFromStart() More...
	TimeSeriesSequence ()
	Default constructor. More...
	TimeSeriesSequence (int value_dim)
	Construct empty time series sequence with a desired value vector dimension. More...

Private Attributes
std::vector< TimeSeries::Ptr >	_ts_sequence
int	_value_dim = 0
	We enforce a unique value dimension for all internal time_series objects. More...

Detailed Description

Sequence of time series objects.

Individual time series might be sorted w.r.t different TimeSeries::timeFromStart() values e.g. in order to indicate planned or predicted trajectories at each individual sampling interval.

See also

TimeSeries TimeSeriesSequenceSignal TimeSeriesSignal

Author

Christoph Rösmann (chris.nosp@m.toph.nosp@m..roes.nosp@m.mann.nosp@m.@tu-d.nosp@m.ortm.nosp@m.und.d.nosp@m.e)

Definition at line 260 of file time_series.h.

Member Typedef Documentation

ConstPtr

using corbo::TimeSeriesSequence::ConstPtr = std::shared_ptr<const TimeSeriesSequence>

Definition at line 264 of file time_series.h.

Ptr

using corbo::TimeSeriesSequence::Ptr = std::shared_ptr<TimeSeriesSequence>

Definition at line 263 of file time_series.h.

Constructor & Destructor Documentation

TimeSeriesSequence() [1/2]

corbo::TimeSeriesSequence::TimeSeriesSequence ( )

inline

Default constructor.

Definition at line 267 of file time_series.h.

TimeSeriesSequence() [2/2]

corbo::TimeSeriesSequence::TimeSeriesSequence ( int  value_dim )

inlineexplicit

Construct empty time series sequence with a desired value vector dimension.

Definition at line 270 of file time_series.h.

Member Function Documentation

add()

bool corbo::TimeSeriesSequence::add

(

TimeSeries::Ptr

ts

)

Add shared instance of a time series (without copying)

Definition at line 456 of file time_series.cpp.

clear()

void corbo::TimeSeriesSequence::clear

(

)

Erase all time series.

Definition at line 473 of file time_series.cpp.

getSequence()

const std::vector<TimeSeries::Ptr>& corbo::TimeSeriesSequence::getSequence ( ) const

inline

Read access to the underlying sequence of time series (shared instances)

Definition at line 285 of file time_series.h.

getValueDimension()

int corbo::TimeSeriesSequence::getValueDimension ( ) const

inline

Return dimension of the value vector.

Definition at line 273 of file time_series.h.

isEmpty()

bool corbo::TimeSeriesSequence::isEmpty ( ) const

inline

Determine if no time series is available.

Definition at line 275 of file time_series.h.

setValueDimension()

void corbo::TimeSeriesSequence::setValueDimension

(

int

value_dim

)

Change value dimension (warning: clears existing values)

Definition at line 447 of file time_series.cpp.

sortByTimeFromStart()

void corbo::TimeSeriesSequence::sortByTimeFromStart

(

)

Ascending sort of the time series objects according to their TimeSeries::timeFromStart()

Definition at line 479 of file time_series.cpp.

Member Data Documentation

_ts_sequence

std::vector<TimeSeries::Ptr> corbo::TimeSeriesSequence::_ts_sequence

private

Definition at line 301 of file time_series.h.

_value_dim

int corbo::TimeSeriesSequence::_value_dim = 0

private

We enforce a unique value dimension for all internal time_series objects.

Definition at line 303 of file time_series.h.

---

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

• time_series.h
• time_series.cpp