Public Member Functions | List of all members
iinsp::IModelTeachController Class Referenceabstract

Interface for someone controlling teaching of model data. More...

#include <IModelTeachController.h>

Inheritance diagram for iinsp::IModelTeachController:
istd::IChangeable istd::IPolymorphic

Public Member Functions

virtual bool IsModelTeachable (const iprm::IParamsSet &modelParams, const iprm::IParamsSet *modelDataPtr=NULL, bool beQuiet=false, bool *needUserInteractionPtr=NULL) const =0
 Check of it is possible to teach the model using some parameters. More...
 
virtual bool DoModelTeach (const iprm::IParamsSet &modelParams, iprm::IParamsSet &result, bool beQuiet=false) const =0
 Teach the model using some input parameters. More...
 
virtual void ResetModelData (iprm::IParamsSet &result) const =0
 Clear all data of the model. More...
 
virtual bool IsModelDataValid (const iprm::IParamsSet &modelData) const =0
 Check if the model data are valid. More...
 

Detailed Description

Interface for someone controlling teaching of model data.

Definition at line 17 of file IModelTeachController.h.

Member Function Documentation

virtual bool iinsp::IModelTeachController::DoModelTeach ( const iprm::IParamsSet modelParams,
iprm::IParamsSet result,
bool  beQuiet = false 
) const
pure virtual

Teach the model using some input parameters.

Parameters
modelParamsinput model parameters.
resultoutput model data, it can be the same object as modelParams.
beQuietif true, no user interaction is allowed.
Returns
true, if it was possible to teach the model.
virtual bool iinsp::IModelTeachController::IsModelDataValid ( const iprm::IParamsSet modelData) const
pure virtual

Check if the model data are valid.

virtual bool iinsp::IModelTeachController::IsModelTeachable ( const iprm::IParamsSet modelParams,
const iprm::IParamsSet modelDataPtr = NULL,
bool  beQuiet = false,
bool *  needUserInteractionPtr = NULL 
) const
pure virtual

Check of it is possible to teach the model using some parameters.

Parameters
modelParamsinput model parameters.
modelDataPtroptional model data, it can be the same object as modelParams.
beQuietindicate that this request is only for model teach without user interactions.
needUserInteractionPtroptional placeholder for output flag indicating that user interaction will be requested during teach.
virtual void iinsp::IModelTeachController::ResetModelData ( iprm::IParamsSet result) const
pure virtual

Clear all data of the model.


The documentation for this class was generated from the following file:

© 2007-2017 Witold Gantzke and Kirill Lepskiy