Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

ExportSignalsSettings Class Reference

Last update: 16.07.2025

Stores 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_pathThe 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
delimiterThe 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
databasethe database that is being checked
Exceptions
std::exceptionIf the settings are not correct

◆ save()

save ( Structure  database)

Exports all data to the given CSV output files.

Parameters
databaseThe database containing all objects.
Exceptions
std::exceptionIf the output_path is not a directory std::exception If one of the output_files is not writeable

Connect with Ansys