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

Export yaml files. More...

#include <yaml_export.h>

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

Public Types

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

Public Member Functions

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

Private Member Functions

void emitHeader (const SignalHeader &header, YAML::Emitter &emitter)
 
void emitIndexedValues (const IndexedValuesSignal &signal, YAML::Emitter &emitter, bool wrap_in_map=true)
 
void emitIndexedValuesSet (const IndexedValuesSetSignal &signal, YAML::Emitter &emitter, bool wrap_in_map=true)
 
void emitMatrix (const MatrixSignal &signal, YAML::Emitter &emitter, bool wrap_in_map=true)
 
void emitMatrixSet (const MatrixSetSignal &signal, YAML::Emitter &emitter, bool wrap_in_map=true)
 
void emitSignalGroup (const CommonSignalTarget::SignalGroup &signal_group, YAML::Emitter &emitter, bool wrap_in_map=true)
 
void emitTimeSeries (const TimeSeries &time_series, YAML::Emitter &emitter, bool wrap_in_map=true)
 
void emitTimeSeries (const TimeSeriesSignal &signal, YAML::Emitter &emitter, bool wrap_in_map=true)
 
void emitTimeSeriesSequence (const TimeSeriesSequenceSignal &signal, YAML::Emitter &emitter, bool wrap_in_map=true)
 
bool write_file (const YAML::Emitter &emitter, const std::string &filename)
 

Additional Inherited Members

- Static Public Member Functions inherited from corbo::DataExporterInterface
static Factory< DataExporterInterface > & getFactory ()
 Get access to the associated factory. More...
 

Detailed Description

Export yaml files.

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)
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)

Definition at line 44 of file yaml_export.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 47 of file yaml_export.h.

Constructor & Destructor Documentation

◆ YamlExporter()

corbo::YamlExporter::YamlExporter ( )

Member Function Documentation

◆ emitHeader()

void corbo::YamlExporter::emitHeader ( const SignalHeader &  header,
YAML::Emitter &  emitter 
)
private

◆ emitIndexedValues()

void corbo::YamlExporter::emitIndexedValues ( const IndexedValuesSignal &  signal,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ emitIndexedValuesSet()

void corbo::YamlExporter::emitIndexedValuesSet ( const IndexedValuesSetSignal &  signal,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ emitMatrix()

void corbo::YamlExporter::emitMatrix ( const MatrixSignal &  signal,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ emitMatrixSet()

void corbo::YamlExporter::emitMatrixSet ( const MatrixSetSignal &  signal,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ emitSignalGroup()

void corbo::YamlExporter::emitSignalGroup ( const CommonSignalTarget::SignalGroup &  signal_group,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ emitTimeSeries() [1/2]

void corbo::YamlExporter::emitTimeSeries ( const TimeSeries &  time_series,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ emitTimeSeries() [2/2]

void corbo::YamlExporter::emitTimeSeries ( const TimeSeriesSignal &  signal,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ emitTimeSeriesSequence()

void corbo::YamlExporter::emitTimeSeriesSequence ( const TimeSeriesSequenceSignal &  signal,
YAML::Emitter &  emitter,
bool  wrap_in_map = true 
)
private

◆ exportIndexedValuesSetSignal()

bool corbo::YamlExporter::exportIndexedValuesSetSignal ( const std::string &  filename,
const IndexedValuesSetSignal &  signal 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ exportIndexedValuesSignal()

bool corbo::YamlExporter::exportIndexedValuesSignal ( const std::string &  filename,
const IndexedValuesSignal &  signal 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ exportMatrixSetSignal()

bool corbo::YamlExporter::exportMatrixSetSignal ( const std::string &  filename,
const MatrixSetSignal &  signal 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ exportMatrixSignal()

bool corbo::YamlExporter::exportMatrixSignal ( const std::string &  filename,
const MatrixSignal &  signal 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ exportSignalGroup()

bool corbo::YamlExporter::exportSignalGroup ( const std::string &  filename,
const CommonSignalTarget::SignalGroup &  signal_group 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ exportTimeSeries()

bool corbo::YamlExporter::exportTimeSeries ( const std::string &  filename,
const TimeSeries &  time_series 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ exportTimeSeriesSequenceSignal()

bool corbo::YamlExporter::exportTimeSeriesSequenceSignal ( const std::string &  filename,
const TimeSeriesSequenceSignal &  signal 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ exportTimeSeriesSignal()

bool corbo::YamlExporter::exportTimeSeriesSignal ( const std::string &  filename,
const TimeSeriesSignal &  signal 
)
overridevirtual

Reimplemented from corbo::DataExporterInterface.

◆ getFileSuffix()

std::string corbo::YamlExporter::getFileSuffix ( ) const
inlineoverridevirtual

Implements corbo::DataExporterInterface.

Definition at line 54 of file yaml_export.h.

◆ getFormatName()

std::string corbo::YamlExporter::getFormatName ( ) const
inlineoverridevirtual

Implements corbo::DataExporterInterface.

Definition at line 53 of file yaml_export.h.

◆ getInstance()

DataExporterInterface::Ptr corbo::YamlExporter::getInstance ( ) const
inlineoverridevirtual

Return a newly created shared instance of the implemented class.

Implements corbo::DataExporterInterface.

Definition at line 51 of file yaml_export.h.

◆ isSupportingIndexedValuesSetSignal()

bool corbo::YamlExporter::isSupportingIndexedValuesSetSignal ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 61 of file yaml_export.h.

◆ isSupportingIndexedValuesSignal()

bool corbo::YamlExporter::isSupportingIndexedValuesSignal ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 60 of file yaml_export.h.

◆ isSupportingMatrixSetSignal()

bool corbo::YamlExporter::isSupportingMatrixSetSignal ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 63 of file yaml_export.h.

◆ isSupportingMatrixSignal()

bool corbo::YamlExporter::isSupportingMatrixSignal ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 62 of file yaml_export.h.

◆ isSupportingSignalGroup()

bool corbo::YamlExporter::isSupportingSignalGroup ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 56 of file yaml_export.h.

◆ isSupportingTimeSeries()

bool corbo::YamlExporter::isSupportingTimeSeries ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 58 of file yaml_export.h.

◆ isSupportingTimeSeriesSequenceSignal()

bool corbo::YamlExporter::isSupportingTimeSeriesSequenceSignal ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 59 of file yaml_export.h.

◆ isSupportingTimeSeriesSignal()

bool corbo::YamlExporter::isSupportingTimeSeriesSignal ( ) const
inlineoverridevirtual

Reimplemented from corbo::DataExporterInterface.

Definition at line 57 of file yaml_export.h.

◆ write_file()

bool corbo::YamlExporter::write_file ( const YAML::Emitter &  emitter,
const std::string &  filename 
)
private
The documentation for this class was generated from the following file:

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