Public Types | Public Member Functions | Static Public Member Functions | List of all members
corbo::DataExporterInterface Class Referenceabstract

Interface class for exporting signals. More...

#include <data_exporter_interface.h>

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

Public Types

using ConstPtr = std::shared_ptr< const DataExporterInterface >
 
using Ptr = std::shared_ptr< DataExporterInterface >
 

Public Member Functions

virtual bool exportIndexedValuesSetSignal (const std::string &filename, const IndexedValuesSetSignal &signal)
 
virtual bool exportIndexedValuesSignal (const std::string &filename, const IndexedValuesSignal &signal)
 
virtual bool exportMatrixSetSignal (const std::string &filename, const MatrixSetSignal &signal)
 
virtual bool exportMatrixSignal (const std::string &filename, const MatrixSignal &signal)
 
virtual bool exportSignalGroup (const std::string &filename, const CommonSignalTarget::SignalGroup &signal_group)
 
virtual bool exportTimeSeries (const std::string &filename, const TimeSeries &time_series)
 
virtual bool exportTimeSeriesSequenceSignal (const std::string &filename, const TimeSeriesSequenceSignal &signal)
 
virtual bool exportTimeSeriesSignal (const std::string &filename, const TimeSeriesSignal &signal)
 
virtual std::string getFileSuffix () const =0
 
virtual std::string getFormatName () const =0
 
virtual Ptr getInstance () const =0
 Return a newly created shared instance of the implemented class. More...
 
virtual bool isSupportingIndexedValuesSetSignal () const
 
virtual bool isSupportingIndexedValuesSignal () const
 
virtual bool isSupportingMatrixSetSignal () const
 
virtual bool isSupportingMatrixSignal () const
 
virtual bool isSupportingSignalGroup () const
 
virtual bool isSupportingTimeSeries () const
 
virtual bool isSupportingTimeSeriesSequenceSignal () const
 
virtual bool isSupportingTimeSeriesSignal () const
 
virtual ~DataExporterInterface ()
 

Static Public Member Functions

static Factory< DataExporterInterface > & getFactory ()
 Get access to the associated factory. More...
 

Detailed Description

Interface class for exporting signals.

Author
Maximilian Krämer (maxim.nosp@m.ilia.nosp@m.n.kra.nosp@m.emer.nosp@m.@tu-d.nosp@m.ortm.nosp@m.und.d.nosp@m.e)
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 45 of file data_exporter_interface.h.

Member Typedef Documentation

◆ ConstPtr

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

Definition at line 49 of file data_exporter_interface.h.

◆ Ptr

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

Definition at line 48 of file data_exporter_interface.h.

Constructor & Destructor Documentation

◆ ~DataExporterInterface()

virtual corbo::DataExporterInterface::~DataExporterInterface ( )
inlinevirtual

Definition at line 51 of file data_exporter_interface.h.

Member Function Documentation

◆ exportIndexedValuesSetSignal()

bool corbo::DataExporterInterface::exportIndexedValuesSetSignal ( const std::string &  filename,
const IndexedValuesSetSignal &  signal 
)
virtual

Reimplemented in corbo::YamlExporter.

Definition at line 61 of file data_exporter_interface.cpp.

◆ exportIndexedValuesSignal()

bool corbo::DataExporterInterface::exportIndexedValuesSignal ( const std::string &  filename,
const IndexedValuesSignal &  signal 
)
virtual

Reimplemented in corbo::YamlExporter.

Definition at line 55 of file data_exporter_interface.cpp.

◆ exportMatrixSetSignal()

bool corbo::DataExporterInterface::exportMatrixSetSignal ( const std::string &  filename,
const MatrixSetSignal &  signal 
)
virtual

Reimplemented in corbo::YamlExporter.

Definition at line 73 of file data_exporter_interface.cpp.

◆ exportMatrixSignal()

bool corbo::DataExporterInterface::exportMatrixSignal ( const std::string &  filename,
const MatrixSignal &  signal 
)
virtual

Reimplemented in corbo::YamlExporter.

Definition at line 67 of file data_exporter_interface.cpp.

◆ exportSignalGroup()

bool corbo::DataExporterInterface::exportSignalGroup ( const std::string &  filename,
const CommonSignalTarget::SignalGroup &  signal_group 
)
virtual

Reimplemented in corbo::YamlExporter.

Definition at line 31 of file data_exporter_interface.cpp.

◆ exportTimeSeries()

bool corbo::DataExporterInterface::exportTimeSeries ( const std::string &  filename,
const TimeSeries &  time_series 
)
virtual

Reimplemented in corbo::YamlExporter, and corbo::TsvExporter.

Definition at line 43 of file data_exporter_interface.cpp.

◆ exportTimeSeriesSequenceSignal()

bool corbo::DataExporterInterface::exportTimeSeriesSequenceSignal ( const std::string &  filename,
const TimeSeriesSequenceSignal &  signal 
)
virtual

Reimplemented in corbo::YamlExporter.

Definition at line 49 of file data_exporter_interface.cpp.

◆ exportTimeSeriesSignal()

bool corbo::DataExporterInterface::exportTimeSeriesSignal ( const std::string &  filename,
const TimeSeriesSignal &  signal 
)
virtual

Reimplemented in corbo::YamlExporter, and corbo::TsvExporter.

Definition at line 37 of file data_exporter_interface.cpp.

◆ getFactory()

static Factory<DataExporterInterface>& corbo::DataExporterInterface::getFactory ( )
inlinestatic

Get access to the associated factory.

Definition at line 57 of file data_exporter_interface.h.

◆ getFileSuffix()

virtual std::string corbo::DataExporterInterface::getFileSuffix ( ) const
pure virtual

Implemented in corbo::YamlExporter, and corbo::TsvExporter.

◆ getFormatName()

virtual std::string corbo::DataExporterInterface::getFormatName ( ) const
pure virtual

Implemented in corbo::YamlExporter, and corbo::TsvExporter.

◆ getInstance()

virtual Ptr corbo::DataExporterInterface::getInstance ( ) const
pure virtual

Return a newly created shared instance of the implemented class.

Implemented in corbo::YamlExporter, and corbo::TsvExporter.

◆ isSupportingIndexedValuesSetSignal()

virtual bool corbo::DataExporterInterface::isSupportingIndexedValuesSetSignal ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter, and corbo::TsvExporter.

Definition at line 67 of file data_exporter_interface.h.

◆ isSupportingIndexedValuesSignal()

virtual bool corbo::DataExporterInterface::isSupportingIndexedValuesSignal ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter, and corbo::TsvExporter.

Definition at line 66 of file data_exporter_interface.h.

◆ isSupportingMatrixSetSignal()

virtual bool corbo::DataExporterInterface::isSupportingMatrixSetSignal ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter.

Definition at line 69 of file data_exporter_interface.h.

◆ isSupportingMatrixSignal()

virtual bool corbo::DataExporterInterface::isSupportingMatrixSignal ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter.

Definition at line 68 of file data_exporter_interface.h.

◆ isSupportingSignalGroup()

virtual bool corbo::DataExporterInterface::isSupportingSignalGroup ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter, and corbo::TsvExporter.

Definition at line 62 of file data_exporter_interface.h.

◆ isSupportingTimeSeries()

virtual bool corbo::DataExporterInterface::isSupportingTimeSeries ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter, and corbo::TsvExporter.

Definition at line 64 of file data_exporter_interface.h.

◆ isSupportingTimeSeriesSequenceSignal()

virtual bool corbo::DataExporterInterface::isSupportingTimeSeriesSequenceSignal ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter.

Definition at line 65 of file data_exporter_interface.h.

◆ isSupportingTimeSeriesSignal()

virtual bool corbo::DataExporterInterface::isSupportingTimeSeriesSignal ( ) const
inlinevirtual

Reimplemented in corbo::YamlExporter, and corbo::TsvExporter.

Definition at line 63 of file data_exporter_interface.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:02