Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

ImportOptiSLangSignal Class Reference

Last update: 16.07.2025

Sets up an SoS project for a single user defined optiSLang 3 signal identifier. More...

Public Member Functions

 importData (Structure database, string signal_ident)
 Imports all designs of the specified signal identifier from the current optiSLang binary file. More...
 
MetaStructure importMesh (string signal_ident)
 Imports the mesh for the given signal identifier. More...
 
 ImportOptiSLangSignal (string file_path)
 Reads in the optiSLang binary file given. More...
 
std::vector< string > signalIdents ()
 

Public Attributes

string filename
 The absolute path to the optiSlang binary file we are currently dealing with.
 
bool resample_abscissa
 defines the strategy for unifying the support points. true: resamples abscissa if not equal among all designs (default); false: collects all points
 
bool shrink_abscissa
 defines the considered interval. true: use minimum existing interval (default), false: use maximum existing interval
 

Detailed Description

Sets up an SoS project for a single user defined optiSLang 3 signal identifier.

Reads in the given optiSLang 3 binary file and provides a list of all present, non-failed channel identifier. The user then selects a single identifier to generate and import its mesh (importMesh) and its data (importData).

Warning
Currently only compatible signal meshes are supported.

Constructor & Destructor Documentation

◆ ImportOptiSLangSignal()

ImportOptiSLangSignal ( string  file_path)

Reads in the optiSLang binary file given.

Parameters
file_pathThe path to an existing optiSLang binary file
Exceptions
std::exceptionIf a filesystem error occurs or the optiSLang binary file is broken

Member Function Documentation

◆ importData()

importData ( Structure  database,
string  signal_ident 
)

Imports all designs of the specified signal identifier from the current optiSLang binary file.

This method tries to import as much designs as possible and does even proceed in case of errors. Currently only compatible meshes may be imported

Parameters
[in,out]databaseThe database where all the compatible data is to be added
signal_identThe signal identifier to be extracted and added to the database
Exceptions
Onincompatible meshes.

◆ importMesh()

MetaStructure importMesh ( string  signal_ident)

Imports the mesh for the given signal identifier.

Parameters
signal_identThe signal identifier used to build the reference mesh.
Returns
A meta structure containing the mesh

◆ signalIdents()

std::vector< string > signalIdents ( )
Returns
A vector listing the idents of all signals

Connect with Ansys