## On this page

  

 

 # CreateModelBase Struct Reference

 Last update: 16.07.2025 

API for all MOP3 model creation classes. [More...](struct_create_model_base.xhtml#details)

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

virtual string [\_\_str\_\_](struct_create_model_base.xhtml#a3031d648b73235d11d64df95db3d84ce) () Output function used in python context. Use this function to print instances of this class in python. [More...](#a3031d648b73235d11d64df95db3d84ce)  
 <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.   
 virtual [ModelBase](class_model_base.xhtml) \* [compute](struct_create_model_base.xhtml#a5e64887b96b93ac8aa95cca396d78f0a) (::data\_handler::DataHandlerBase datahandler, [TrainingPlanBase](struct_training_plan_base.xhtml) training\_plan, quality\_measure::QualityMeasureBase quality\_measure, [CancelBase](struct_cancel_base.xhtml) \*cancel=nullptr)=0 Builds the model from the given samples and returns the model. [More...](#a5e64887b96b93ac8aa95cca396d78f0a)  
 virtual bool [equals](struct_create_model_base.xhtml#a4a1cc8519f2bdb1f9952ceaa3391cbca) ([CreateModelBase](struct_create_model_base.xhtml) other)=0 Checking if the given configurations are equal this this instance. [More...](#a4a1cc8519f2bdb1f9952ceaa3391cbca)  
 <a id="a0e1dd7df82728594fc128ed1c797b0c0"></a>virtual [PropertyList](class_property_list.xhtml) [getProperties](class_property_user_base.xhtml#a0e1dd7df82728594fc128ed1c797b0c0) () Returns the properties stored by this user.   
 virtual bool [isValid](struct_create_model_base.xhtml#a1202ca4468e899d1e6d321ebf59e67a1) (::data\_handler::DataHandlerBase datahandler, [TrainingPlanBase](struct_training_plan_base.xhtml) training\_plan)=0 This function checks if the model can validly be trained from the given samples. [More...](#a1202ca4468e899d1e6d321ebf59e67a1)  
 [CreateModelBase](struct_create_model_base.xhtml) [operator=](struct_create_model_base.xhtml#a95dd7a3a92dfccdf5f49e060644e651b) ([CreateModelBase](struct_create_model_base.xhtml) other) assignement operator [More...](#a95dd7a3a92dfccdf5f49e060644e651b)  
 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="a65a2d27d476efcf99f7bbd35388ff02e"></a>string **node\_name** <a id="acbb9a6e9c62149080b78c707dd1f555c"></a>string **working\_dir** <a id="details" name="details"></a>## Detailed Description

API for all MOP3 model creation classes.



## Member Function Documentation

<a id="a3031d648b73235d11d64df95db3d84ce"></a>## [◆ ](#a3031d648b73235d11d64df95db3d84ce)\_\_str\_\_()

 virtual string \_\_str\_\_  ( )   virtual 

Output function used in python context. Use this function to print instances of this class in python.

Returnsstring containing the object Reimplemented in [CreateCustomModel](class_create_custom_model.xhtml#a3031d648b73235d11d64df95db3d84ce).





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

 virtual [ModelBase](class_model_base.xhtml)\* compute  ( ::data\_handler::DataHandlerBase  *datahandler*,    [TrainingPlanBase](struct_training_plan_base.xhtml)  *training\_plan*,    quality\_measure::QualityMeasureBase  *quality\_measure*,    [CancelBase](struct_cancel_base.xhtml) \*  *cancel* = `nullptr`   )   pure virtual 

Builds the model from the given samples and returns the model.

Parameters datahandlerThe datahandler that contains the samples training\_planThe training plan that specifies how the model will be trained quality\_measureThe quality measure that allows to compute a models approximation quality cancelA cancellation object to cancel the training ReturnsThe trained model iff not cancelled Implemented in [CreateCustomModel](class_create_custom_model.xhtml#adab3d3e83d7c6ba1916a079748b0f152).





<a id="a4a1cc8519f2bdb1f9952ceaa3391cbca"></a>## [◆ ](#a4a1cc8519f2bdb1f9952ceaa3391cbca)equals()

 virtual bool equals  ( [CreateModelBase](struct_create_model_base.xhtml)  *other*)   pure virtual 

Checking if the given configurations are equal this this instance.

Parameters otherThe other Config Returnstrue iff the same type and the same config entries Implemented in [CreateCustomModel](class_create_custom_model.xhtml#ad90ea62af69f033af4b88810fc877308).





<a id="a1202ca4468e899d1e6d321ebf59e67a1"></a>## [◆ ](#a1202ca4468e899d1e6d321ebf59e67a1)isValid()

 virtual bool isValid  ( ::data\_handler::DataHandlerBase  *datahandler*,    [TrainingPlanBase](struct_training_plan_base.xhtml)  *training\_plan*   )   pure virtual 

This function checks if the model can validly be trained from the given samples.

Parameters datahandlerThe samples the model shall be trained with. training\_planThe training\_plan ReturnsTrue iff th emodel can be trained with the configuration data, the properties and samples Implemented in [CreateCustomModel](class_create_custom_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d), [CreateKrigingModel](class_create_kriging_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d), [CreateMLSModel](class_create_m_l_s_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d), [CreateRBFModel](class_create_r_b_f_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d), [CreatePolynomialModel](class_create_polynomial_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d), [CreateLegacyMOPModel](class_create_legacy_m_o_p_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d), and [CreateLegacyMOQModel](class_create_legacy_m_o_q_model.xhtml#a1a42d0ff7ef3b9c17965ecc14310ed5d).





<a id="a95dd7a3a92dfccdf5f49e060644e651b"></a>## [◆ ](#a95dd7a3a92dfccdf5f49e060644e651b)operator=()

 [CreateModelBase](struct_create_model_base.xhtml) operator=  ( [CreateModelBase](struct_create_model_base.xhtml)  *other*) 

assignement operator

ReturnsA raw of type [CreateModelBase](struct_create_model_base.xhtml "API for all MOP3 model creation classes. ") to cloned instance 



<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