Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

CreateMOP Class Reference

Last update: 16.07.2025

Creates a FMOP. More...

Public Member Functions

 addConfig (CreateModelBase config)
 adds a configuration to the FMOP. More...
 
 addConfig (handler::CreateScalarMOP config)
 adds a ScalarMOP configuration to the FMOP. More...
 
virtual addProperty (PropertyBase p)
 Properties that help the ScalarMOP scheduling the Models to be built The properties class needs to be implemented for the specific model type.
 
 check (Structure database)
 destructor More...
 
bool checkOverwriteExisting (Structure database)
 checks if any FCoP values are already existing in the database More...
 
 compute (Structure database)
 computes the new objects More...
 
 CreateMOP ()
 default constructor
 
virtual PropertyList getProperties ()
 Returns the properties stored by this user.
 
handler::CreateScalarMOP getScalarMOPConfig ()
 Access the attached ScalarMOP. More...
 
handler::CreateScalarMOP getScalarMOPConfig ()
 Access the attached ScalarMOP. More...
 
virtual loadJson (JsonValue root)
 Function to read and set up the model configuration through a JSON string. More...
 
virtual bool parseJson (string str)
 Parse a json configuration from a given JSON string. More...
 
virtual JsonValue saveJson () override
 Function to write the Models configuration data as a JSON string. More...
 
virtual transferProperties (PropertyList property_list)
 Convenience function to transfer a complete PropertyList into the model. More...
 

Public Attributes

bool compute_dominant_inputs
 if true, plot the dominant input parameters
 
bool compute_DummyMOP
 Create a simple scalar MOP. This MOP can be exported as an OMDB file, for outlier detection in OptiSLang post-processing. More...
 
bool compute_Rsigma
 if true, compute the CoP values in absolute units, i.e. the quantities "Rsigma[...]"
 
bool compute_sensitivities
 if true, compute the sensitivity values
 
apply SWIGTYPE * DISOWN
 
DataObjectContainer input
 the scalar data objects defining the inputs
 
std::vector< string > mandatory_inputs
 defines the mandatory input idents
 
number minimum_cop
 minimum CoP value for a single item in a FCoP-value to be accepted as active input parameter (relative, 0.01=1%)
 
number minimum_cop_avg
 minimum CoP value for the average FCoP-value to be accepted as active input parameter (relative, 0.01=1%)
 
bool overwrite_existing
 if true, replace existing output objects. if false: throw an error if an output object already exists
 
toolbox::RandomFieldDecompositionFromSamples response
 settings for creation of internal random field model If the random field model is configured to create any output, we will not use it! In this case you need to create a random field model explicitly.
 

Detailed Description

Creates a FMOP.

Member Function Documentation

◆ addConfig() [1/2]

addConfig ( CreateModelBase  config)

adds a configuration to the FMOP.

Parameters
configThe configuration to be added

◆ addConfig() [2/2]

addConfig ( handler::CreateScalarMOP  config)

adds a ScalarMOP configuration to the FMOP.

Parameters
configThe ScalarMOP configuration to be added

◆ check()

check ( Structure  database)

destructor

checks the settings

Parameters
databasethe database we refer to
Exceptions
anexception in case of an error

◆ checkOverwriteExisting()

bool checkOverwriteExisting ( Structure  database)

checks if any FCoP values are already existing in the database

Parameters
databasethe database to be tested
Returns
true if any FCoP objects or FMOP models were already created.

◆ compute()

compute ( Structure  database)

computes the new objects

Parameters
databasethe database we refer to

◆ getScalarMOPConfig() [1/2]

handler::CreateScalarMOP getScalarMOPConfig ( )

Access the attached ScalarMOP.

Returns
A reference to the attached CreateScalarMOP

◆ getScalarMOPConfig() [2/2]

handler::CreateScalarMOP getScalarMOPConfig ( )

Access the attached ScalarMOP.

Returns
A reference to the attached CreateScalarMOP

◆ loadJson()

virtual loadJson ( JsonValue  root)
virtual

Function to read and set up the model configuration through a JSON string.

Parameters
rootThe json string to set up the configuration from

◆ parseJson()

virtual bool parseJson ( string  str)
virtual

Parse a json configuration from a given JSON string.

Parameters
strthe String to parse
Returns
true iff parsing was successful

◆ saveJson()

virtual JsonValue saveJson ( )
overridevirtual

Function to write the Models configuration data as a JSON string.

Returns
The configuration of the model as JSON string

◆ transferProperties()

virtual transferProperties ( PropertyList  property_list)
virtualinherited

Convenience function to transfer a complete PropertyList into the model.

Parameters
property_listThe properties to transfer into this model

Member Data Documentation

◆ compute_DummyMOP

bool compute_DummyMOP

Create a simple scalar MOP. This MOP can be exported as an OMDB file, for outlier detection in OptiSLang post-processing.

See also
MOPContainer::writeInternalMOP_OMDBFile

◆ DISOWN

apply SWIGTYPE * DISOWN
Initial value:
{handler::CreateScalarMOP * create_scalar_mop}
addScalarMOP( handler::CreateScalarMOP * create_scalar_mop )

Connect with Ansys