## On this page

  

 

 # CreateMOP Class Reference

 Last update: 16.07.2025 

Creates a FMOP. [More...](class_create_m_o_p.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

 [addConfig](class_create_m_o_p.xhtml#a8c9e9b33aa08c8adc83c5c603584baf6) ([CreateModelBase](struct_create_model_base.xhtml) config) adds a configuration to the FMOP. [More...](#a8c9e9b33aa08c8adc83c5c603584baf6)  
  [addConfig](class_create_m_o_p.xhtml#aa3e76c9ef2efcfd092bdd9f7dd326d33) (handler::CreateScalarMOP config) adds a [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") configuration to the FMOP. [More...](#aa3e76c9ef2efcfd092bdd9f7dd326d33)  
 <a id="aedfb47575823522e6a6d22ce6c12e826"></a>virtual [addProperty](class_property_user_base.xhtml#aedfb47575823522e6a6d22ce6c12e826) ([PropertyBase](struct_property_base.xhtml) p) Properties that help the [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") scheduling the Models to be built The properties class needs to be implemented for the specific model type.   
  [check](class_create_m_o_p.xhtml#a47c34ec1e578c2ce27cf1c5fcd0d1704) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) destructor [More...](#a47c34ec1e578c2ce27cf1c5fcd0d1704)  
 bool [checkOverwriteExisting](class_create_m_o_p.xhtml#abdcd2125bfa27ba032579f06c6c15b41) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) checks if any FCoP values are already existing in the database [More...](#abdcd2125bfa27ba032579f06c6c15b41)  
  [compute](class_create_m_o_p.xhtml#ab08e112d95fe611e7eb25491c354d115) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) computes the new objects [More...](#ab08e112d95fe611e7eb25491c354d115)  
 <a id="a304bfd9679f4c372a141f5d955ec83a3"></a> [CreateMOP](class_create_m_o_p.xhtml#a304bfd9679f4c372a141f5d955ec83a3) () default constructor   
 <a id="a0e1dd7df82728594fc128ed1c797b0c0"></a>virtual [PropertyList](class_property_list.xhtml) [getProperties](class_property_user_base.xhtml#a0e1dd7df82728594fc128ed1c797b0c0) () Returns the properties stored by this user.   
 handler::CreateScalarMOP [getScalarMOPConfig](class_create_m_o_p.xhtml#a7d14aab4b2691328855fbbf13f85f7b8) () Access the attached [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor..."). [More...](#a7d14aab4b2691328855fbbf13f85f7b8)  
 handler::CreateScalarMOP [getScalarMOPConfig](class_create_m_o_p.xhtml#a7d14aab4b2691328855fbbf13f85f7b8) () Access the attached [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor..."). [More...](#a7d14aab4b2691328855fbbf13f85f7b8)  
 virtual [loadJson](class_create_m_o_p.xhtml#a156102bce477295e314bbf612d890470) ([JsonValue](class_json_value.xhtml) root) Function to read and set up the model configuration through a JSON string. [More...](#a156102bce477295e314bbf612d890470)  
 virtual bool [parseJson](class_create_m_o_p.xhtml#afdebedad08779b0d2b8ee6f6aa1f5d37) (string str) Parse a json configuration from a given JSON string. [More...](#afdebedad08779b0d2b8ee6f6aa1f5d37)  
 virtual [JsonValue](class_json_value.xhtml) [saveJson](class_create_m_o_p.xhtml#ab4587af0230811304c91f1c0aaa1c9ce) () override Function to write the Models configuration data as a JSON string. [More...](#ab4587af0230811304c91f1c0aaa1c9ce)  
 virtual [transferProperties](class_property_user_base.xhtml#ab9507274f126b856fb69cd621f0f9fb4) ([PropertyList](class_property_list.xhtml) property\_list) Convenience function to transfer a complete [PropertyList](class_property_list.xhtml "Container class for handling properties Uses templates to easily find and cast configurations of diff...") into the model. [More...](#ab9507274f126b856fb69cd621f0f9fb4)  
 ## <a name="pub-attribs"></a>Public Attributes

<a id="a31388be8837d1a2fdccd883be6692e84"></a>bool [compute\_dominant\_inputs](class_create_m_o_p.xhtml#a31388be8837d1a2fdccd883be6692e84) if true, plot the dominant input parameters   
 bool [compute\_DummyMOP](class_create_m_o_p.xhtml#af42087e96d28f5375e7f37e08aba8445) Create a simple scalar [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat..."). This [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") can be exported as an OMDB file, for outlier detection in OptiSLang post-processing. [More...](#af42087e96d28f5375e7f37e08aba8445)  
 <a id="a9129c769154cd3746f78fd9b07d36759"></a>bool [compute\_Rsigma](class_create_m_o_p.xhtml#a9129c769154cd3746f78fd9b07d36759) if true, compute the [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") values in absolute units, i.e. the quantities "Rsigma\[...\]"   
 <a id="acc2123d14934f5d137ee60eaaaf8be74"></a>bool [compute\_sensitivities](class_create_m_o_p.xhtml#acc2123d14934f5d137ee60eaaaf8be74) if true, compute the sensitivity values   
 apply SWIGTYPE \* **DISOWN** <a id="ac3e2a1c8cf854e4cecaccd2a56b40393"></a>[DataObjectContainer](class_data_object_container.xhtml) [input](class_create_m_o_p.xhtml#ac3e2a1c8cf854e4cecaccd2a56b40393) the scalar data objects defining the inputs   
 <a id="afa3ec58e043b78b59032b10a046e427b"></a>std::vector&lt; string &gt; [mandatory\_inputs](class_create_m_o_p.xhtml#afa3ec58e043b78b59032b10a046e427b) defines the mandatory input idents   
 <a id="a90d02972fa21551bc75a79c411f1081b"></a>number [minimum\_cop](class_create_m_o_p.xhtml#a90d02972fa21551bc75a79c411f1081b) minimum [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") value for a single item in a FCoP-value to be accepted as active input parameter (relative, 0.01=1%)   
 <a id="a8f289a4ff96f4a902ec187af0a20ca98"></a>number [minimum\_cop\_avg](class_create_m_o_p.xhtml#a8f289a4ff96f4a902ec187af0a20ca98) minimum [CoP](struct_co_p.xhtml "Reference implementation for a quality metric for MOP models. ") value for the average FCoP-value to be accepted as active input parameter (relative, 0.01=1%)   
 <a id="ade25e60bd85c8b4abd4f5b416cae0eb9"></a>bool [overwrite\_existing](class_create_m_o_p.xhtml#ade25e60bd85c8b4abd4f5b416cae0eb9) if true, replace existing output objects. if false: throw an error if an output object already exists   
 <a id="a8ae229617ae149528fc20ec659009d6a"></a>toolbox::RandomFieldDecompositionFromSamples [response](class_create_m_o_p.xhtml#a8ae229617ae149528fc20ec659009d6a) 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.   
 <a id="details" name="details"></a>## Detailed Description

Creates a FMOP.



## Member Function Documentation

<a id="a8c9e9b33aa08c8adc83c5c603584baf6"></a>## [◆ ](#a8c9e9b33aa08c8adc83c5c603584baf6)addConfig() \[1/2\]

 addConfig  ( [CreateModelBase](struct_create_model_base.xhtml)  *config*) 

adds a configuration to the FMOP.

Parameters configThe configuration to be added 



<a id="aa3e76c9ef2efcfd092bdd9f7dd326d33"></a>## [◆ ](#aa3e76c9ef2efcfd092bdd9f7dd326d33)addConfig() \[2/2\]

 addConfig  ( handler::CreateScalarMOP  *config*) 

adds a [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") configuration to the FMOP.

Parameters configThe [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") configuration to be added 



<a id="a47c34ec1e578c2ce27cf1c5fcd0d1704"></a>## [◆ ](#a47c34ec1e578c2ce27cf1c5fcd0d1704)check()

 check  ( [Structure](class_structure.xhtml)  *database*) 

destructor

checks the settings

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



<a id="abdcd2125bfa27ba032579f06c6c15b41"></a>## [◆ ](#abdcd2125bfa27ba032579f06c6c15b41)checkOverwriteExisting()

 bool checkOverwriteExisting  ( [Structure](class_structure.xhtml)  *database*) 

checks if any FCoP values are already existing in the database

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



<a id="ab08e112d95fe611e7eb25491c354d115"></a>## [◆ ](#ab08e112d95fe611e7eb25491c354d115)compute()

 compute  ( [Structure](class_structure.xhtml)  *database*) 

computes the new objects

Parameters databasethe database we refer to 



<a id="a7d14aab4b2691328855fbbf13f85f7b8"></a>## [◆ ](#a7d14aab4b2691328855fbbf13f85f7b8)getScalarMOPConfig() \[1/2\]

 handler::CreateScalarMOP getScalarMOPConfig  ( ) 

Access the attached [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...").

ReturnsA reference to the attached [CreateScalarMOP](class_create_scalar_m_o_p.xhtml "Creation/Configuration class for the ScalarMOP CreateScalarMOP may be given a number of Model Configu...") 



<a id="a7d14aab4b2691328855fbbf13f85f7b8"></a>## [◆ ](#a7d14aab4b2691328855fbbf13f85f7b8)getScalarMOPConfig() \[2/2\]

 handler::CreateScalarMOP getScalarMOPConfig  ( ) 

Access the attached [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...").

ReturnsA reference to the attached [CreateScalarMOP](class_create_scalar_m_o_p.xhtml "Creation/Configuration class for the ScalarMOP CreateScalarMOP may be given a number of Model Configu...") 



<a id="a156102bce477295e314bbf612d890470"></a>## [◆ ](#a156102bce477295e314bbf612d890470)loadJson()

 virtual loadJson  ( [JsonValue](class_json_value.xhtml)  *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 



<a id="afdebedad08779b0d2b8ee6f6aa1f5d37"></a>## [◆ ](#afdebedad08779b0d2b8ee6f6aa1f5d37)parseJson()

 virtual bool parseJson  ( string  *str*)   virtual 

Parse a json configuration from a given JSON string.

Parameters strthe String to parse Returnstrue iff parsing was successful 



<a id="ab4587af0230811304c91f1c0aaa1c9ce"></a>## [◆ ](#ab4587af0230811304c91f1c0aaa1c9ce)saveJson()

 virtual [JsonValue](class_json_value.xhtml) saveJson  ( )   overridevirtual 

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

ReturnsThe configuration of the model as JSON string 



<a id="ab9507274f126b856fb69cd621f0f9fb4"></a>## [◆ ](#ab9507274f126b856fb69cd621f0f9fb4)transferProperties()

 virtual transferProperties  ( [PropertyList](class_property_list.xhtml)  *property\_list*)   virtualinherited 

Convenience function to transfer a complete [PropertyList](class_property_list.xhtml "Container class for handling properties Uses templates to easily find and cast configurations of diff...") into the model.

Parameters property\_listThe properties to transfer into this model 



## Member Data Documentation

<a id="af42087e96d28f5375e7f37e08aba8445"></a>## [◆ ](#af42087e96d28f5375e7f37e08aba8445)compute\_DummyMOP

 bool compute\_DummyMOP

Create a simple scalar [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat..."). This [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...") can be exported as an OMDB file, for outlier detection in OptiSLang post-processing.

See also[MOPContainer::writeInternalMOP\_OMDBFile](class_m_o_p_container.xhtml#a4b62e4b6dbc152d68e1f5d07c484bfea "writes the OMDB file of the internal MOP of an FMOP to a file ") 



<a id="aa936348f586ed71a2a8585a4b16b20fc"></a>## [◆ ](#aa936348f586ed71a2a8585a4b16b20fc)DISOWN

 apply SWIGTYPE \* DISOWN

**Initial value:**{handler::CreateScalarMOP * create_scalar_mop}



 addScalarMOP( handler::CreateScalarMOP * create_scalar_mop )