Diana  0.8.3
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
MultipleFittingTask Class Reference

#include <DianaMultipleParameterFittingTask.hpp>

Inheritance diagram for MultipleFittingTask:
DianaNLPTask IDianaNLPTaskReporting IDianaSensitivityTaskCreator ICapeNLPTask ICapeUtilities ICapeIdentification SensMultipleFittingTask

List of all members.

Public Member Functions

 MultipleFittingTask (const Common::Types::CapeArrayString &_arrUniqueParamsNames)
 ~MultipleFittingTask ()
void AddParameterFittingTask (DianaParameterFittingTask *_Task)
virtual eCapeNLPTaskType Type () const
virtual CapeDouble CalcObjFunction () throw (Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError)
Common::Collection::ICapeCollectionGetParameters () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl)
void EnableOutput (const Common::Types::CapeString &stream_name) throw (Common::Error::ECapeUnknown)
void DisableOutput ()
void Output (Diana::SolverEvents event)
virtual const
Common::Types::CapeString
GetComponentName () const throw (Common::Error::ECapeUnknown)
virtual const
Common::Types::CapeString
GetComponentDescription () const throw (Common::Error::ECapeUnknown)
virtual void Initialize () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder)
Numeric::Solvers::NLPTasks::ICapeNLPTaskGetSensitivityTask () throw (Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown)

Protected Member Functions

DianaNLPTaskParametersList ExtractParamsForTask (Common::Types::CapeLong _nTask, const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &_parVals)

Protected Attributes

Common::Types::CapeString strName
 Component name.
Common::Types::CapeString strDescription
 Component description.
std::vector< CapeArrayLongmtrMappingTable
 Table that contain indeces of parameters for one-experimental fitting task.
ArrayDianaParameterFittingTask arrTasks
 Array of parameter fitting tasks based on one experiment. Represent each single experiment.
Diana::DianaCollection collParameters
 Collection of Task parameters.
Common::Types::CapeArrayString arrUniqueParamsNames
 Array of parameters names which are unique for each task.

Private Member Functions

void SoughtParametersMapping (const Common::Types::CapeArrayString &_arrUniqueParamsNames)

Detailed Description

Represents class for fitting task with a great number of experiments.


Constructor & Destructor Documentation

MultipleFittingTask ( const Common::Types::CapeArrayString _arrUniqueParamsNames)

Constructor for parameter fitting task class based on more than one experiment.

Parameters:
_arrUniqueParamsNames- names of parameters which are unique for each task.

Adds one-experimental fitting task to multi-experimental task. Destructor Constructor for parameter fitting task class based on more than one experiment.


Member Function Documentation

Add parameter fitting task.

Parameters:
_Task- fitting task based on one experiment

References MultipleFittingTask::arrTasks.

Calculates and returns objective function value for optimization task.

Implements ICapeNLPTask.

void DisableOutput ( )

Disables output of CalcObjFunction.

Enables output of CalcObjFunction.

DianaNLPTaskParametersList ExtractParamsForTask ( Common::Types::CapeLong  _nTask,
const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint _parVals 
) [protected]

Extracts parameters for given one-experimental fitting task from set of parameters for multi-experimental task.

Parameters:
_nTaskindex of one-experimental fitting in arrTasks
_parValsset of parameters for multi-experimental task

gets the description of the component.

Implements ICapeIdentification.

Reimplemented in SensMultipleFittingTask.

virtual const Common::Types::CapeString& GetComponentName ( ) const throw (Common::Error::ECapeUnknown) [virtual]

gets the name of the component.

Implements ICapeIdentification.

Reimplemented in SensMultipleFittingTask.

Returns an ICapeCollection interface. This interface will contain a collection of ICapeParameter interfaces. This method allows any client to access all the Cape Open Parameters exposed by a model component. If the model component does not support exposing its parameters, it should raise the ECapeNoImpl error, instead of returning a NULL reference or an empty Collection. But if the PMC supports parameters but has for this call no parameters, it should return a valid ICapeCollection reference exposing zero parameters.

Reimplemented from DianaNLPTask.

References MultipleFittingTask::collParameters.

Returns created and initialized SensMultipleFittingTask based on current instance.

Implements IDianaSensitivityTaskCreator.

The environment will order the component to get initialized through this method. Any initialisation that could fail must be placed here. Initialize is guaranteed to be the first method called by the client (except low level methods such as class constructors or initialization persistence methods). Initialize has to be called once when the component is instantiated in a particular flowsheet. When the initialization fails, before signalling an error, the component must free all the resources that were allocated before the failure occurred. When the environment receives this error, it may not use the component anymore. The method terminate of the current interface must not either be called. Hence, the environment may only release the component through the middleware native mechanisms.

Reimplemented from DianaNLPTask.

void Output ( Diana::SolverEvents  event) [virtual]

Send notification to report hadler

Parameters:
event- reporting event.

Implements IDianaNLPTaskReporting.

void SoughtParametersMapping ( const Common::Types::CapeArrayString _arrUniqueParamsNames) [private]

Fills mapping table for fitting parameters

virtual eCapeNLPTaskType Type ( ) const [inline, virtual]

Returns type of solver that can be used for solvin this task

Implements ICapeNLPTask.

Reimplemented in SensMultipleFittingTask.

References Numeric::Solvers::NLPTasks::CAPE_NULLRANGE.


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