ExportSignalsSettings Class Reference
Last update: 16.07.2025Stores settings for export signals to a couple of CSV files. More...
Public Member Functions | |
| check (Structure database) | |
| Checks some settings. More... | |
| ExportSignalsSettings (string output_path, string delimiter=",") | |
| Default constructor initializing all member variables to valid defaults. More... | |
| save (Structure database) | |
| Exports all data to the given CSV output files. More... | |
Public Attributes | |
| string | delimiter |
| The delimiter string, e.g. ",", which delimits the data entries within one line. | |
| number | factor |
| The sigma level when exporting the confidence interval. Default: 2. | |
| string | output_file_cop |
| The name of the CoP values output file Default: cop.csv If empty, the file is not exported. | |
| string | output_file_cop_abs |
| The name of the output file name for the absolute CoP values (R*sigma) Default: cop_abs.csv If empty, the file is not exported. | |
| string | output_file_interval |
| The name of the output file name for the confidence interval by the FMOP Default: cop_interval.csv If empty, the file is not exported. | |
| bool | replace_files |
| If this is true, an existings output file will be overwritten. Otherwise an exception will arise. | |
Detailed Description
Stores settings for export signals to a couple of CSV files.
Constructor & Destructor Documentation
◆ ExportSignalsSettings()
| ExportSignalsSettings | ( | string | output_path, |
| string | delimiter = "," |
||
| ) |
Default constructor initializing all member variables to valid defaults.
- Parameters
-
output_path The name of the output directory. Will be used to generate default file paths for all CSV files written by this class. To modify these autogenerated paths set the proper file name variable delimiter The delimiter string, e.g. ";", which delimits the data values within a record. See csv::CSVParser::m_delimiter for more details.
Member Function Documentation
◆ check()
| check | ( | Structure | database | ) |
Checks some settings.
- Parameters
-
database the database that is being checked
- Exceptions
-
std::exception If the settings are not correct
◆ save()
| save | ( | Structure | database | ) |
Exports all data to the given CSV output files.
- Parameters
-
database The database containing all objects.
- Exceptions
-
std::exception If the output_path is not a directory std::exception If one of the output_files is not writeable