Public Types | Public Member Functions | Private Attributes | List of all members
corbo::TimeSeriesSequenceSignal Class Reference

Signal for a sequence of time series objects. More...

#include <signals.h>

Inheritance diagram for corbo::TimeSeriesSequenceSignal:
Inheritance graph
[legend]

Public Types

using ConstPtr = std::shared_ptr< const TimeSeriesSequenceSignal >
 
using Ptr = std::shared_ptr< TimeSeriesSequenceSignal >
 
- Public Types inherited from corbo::SignalInterface
using ConstPtr = std::shared_ptr< const SignalInterface >
 
using Ptr = std::shared_ptr< SignalInterface >
 

Public Member Functions

void add (TimeSeries::Ptr ts)
 Add a new time serie to the sequence. More...
 
const TimeSeriesSequencegetSequence () const
 Read access to the underlying time series sequence (returns null if not initialized) More...
 
TimeSeriesSequence::Ptr getSequencePtr () const
 Return shared pointer of the underlying time series sequence (can be empty if not initialized) More...
 
TimeSeriesSequencegetSequenceRaw ()
 Raw access to the underlying time series sequence (returns null if not initialized) More...
 
SignalType getType () const override
 Get the signal type according to enumeration SignalType. More...
 
void getValueLabels (std::vector< std::string > &sublabels) const override
 Return labels for the underlying components of the signal (e.g. axes labels) More...
 
bool isEmpty () const
 Determine if no time series is available. More...
 
void set (TimeSeriesSequence::Ptr ts_sequence)
 Set time series sequence (and override any existing) More...
 
 TimeSeriesSequenceSignal ()
 Default constructor. More...
 
 TimeSeriesSequenceSignal (int value_dim)
 Construct empty signal with a desired value vector dimension. More...
 
- Public Member Functions inherited from corbo::SignalInterface
virtual ~SignalInterface ()
 Virtual destructor. More...
 

Private Attributes

TimeSeriesSequence::Ptr _ts_sequence
 

Additional Inherited Members

- Public Attributes inherited from corbo::SignalInterface
SignalHeader header
 The header of the signal. More...
 

Detailed Description

Signal for a sequence of time series objects.

This signal stores a 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. This class wraps a TimeSeriesSequence object into a signal along with a SignalHeader.

See also
TimeSeriesSequence TimeSeriesSignal TimeSeries SignalInterface Measurement
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 333 of file signals.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 337 of file signals.h.

◆ Ptr

Definition at line 336 of file signals.h.

Constructor & Destructor Documentation

◆ TimeSeriesSequenceSignal() [1/2]

corbo::TimeSeriesSequenceSignal::TimeSeriesSequenceSignal ( )
inline

Default constructor.

Definition at line 340 of file signals.h.

◆ TimeSeriesSequenceSignal() [2/2]

corbo::TimeSeriesSequenceSignal::TimeSeriesSequenceSignal ( int  value_dim)
inlineexplicit

Construct empty signal with a desired value vector dimension.

Definition at line 342 of file signals.h.

Member Function Documentation

◆ add()

void corbo::TimeSeriesSequenceSignal::add ( TimeSeries::Ptr  ts)

Add a new time serie to the sequence.

Definition at line 114 of file signals.cpp.

◆ getSequence()

const TimeSeriesSequence* corbo::TimeSeriesSequenceSignal::getSequence ( ) const
inline

Read access to the underlying time series sequence (returns null if not initialized)

Definition at line 363 of file signals.h.

◆ getSequencePtr()

TimeSeriesSequence::Ptr corbo::TimeSeriesSequenceSignal::getSequencePtr ( ) const
inline

Return shared pointer of the underlying time series sequence (can be empty if not initialized)

Definition at line 368 of file signals.h.

◆ getSequenceRaw()

TimeSeriesSequence* corbo::TimeSeriesSequenceSignal::getSequenceRaw ( )
inline

Raw access to the underlying time series sequence (returns null if not initialized)

Definition at line 365 of file signals.h.

◆ getType()

SignalType corbo::TimeSeriesSequenceSignal::getType ( ) const
inlineoverridevirtual

Get the signal type according to enumeration SignalType.

Implements corbo::SignalInterface.

Definition at line 347 of file signals.h.

◆ getValueLabels()

void corbo::TimeSeriesSequenceSignal::getValueLabels ( std::vector< std::string > &  sublabels) const
inlineoverridevirtual

Return labels for the underlying components of the signal (e.g. axes labels)

Reimplemented from corbo::SignalInterface.

Definition at line 349 of file signals.h.

◆ isEmpty()

bool corbo::TimeSeriesSequenceSignal::isEmpty ( ) const
inline

Determine if no time series is available.

Definition at line 345 of file signals.h.

◆ set()

void corbo::TimeSeriesSequenceSignal::set ( TimeSeriesSequence::Ptr  ts_sequence)
inline

Set time series sequence (and override any existing)

Definition at line 360 of file signals.h.

Member Data Documentation

◆ _ts_sequence

TimeSeriesSequence::Ptr corbo::TimeSeriesSequenceSignal::_ts_sequence
private

Definition at line 378 of file signals.h.


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


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Mon Feb 28 2022 22:08:03