DianaParameterFittingTask Class Reference

#include <DianaParameterFittingTask.hpp>

Inheritance diagram for DianaParameterFittingTask:

List of all members.

Public Member Functions
	DianaParameterFittingTask (const Common::NLPData::CapeMeasuredData *_expdata, Numeric::Solvers::Solver::ICapeNumericSolver *_solver=NULL, Numeric::Solvers::Model::ICapeNumericContinuousModel *_model=NULL, IDianaMain *_dianaMain=NULL, CapeString _solverName=NULL)
virtual	~DianaParameterFittingTask ()
virtual void	SetNLPParameters (Parameters::ICapeOptimizationPoint *_pars) throw (Common::Error::ECapeUnknown)
const Common::NLPData::CapeMeasuredData *	GetExpData () throw (Common::Error::ECapeUnknown)
void	SetFittingInterval (Common::Types::CapeDouble _startTime, Common::Types::CapeDouble _endTime) throw (Common::Error::ECapeUnknown)
virtual CapeLong	GetFixedSoughtParamsCount ()=0
virtual CapeLong	GetStateSoughtParamsCount ()=0
void	SetStoringStateVariables (const CapeArrayString &names)
void	SetStoringStateVariables (const CapeArrayLong &indices)
const DianaNLPFullMatrixDouble &	GetStoredStates ()
Numeric::Solvers::Eso::ICapeNumericESO *	GetActiveESO () throw (Common::Error::ECapeUnknown)
void	EnableOutput (const Common::Types::CapeString &stream_name) throw (Common::Error::ECapeUnknown)
void	DisableOutput ()
void	SetOutputStateVariables (const CapeArrayString &names)
void	SetReportingInterface (ParameterFittingTaskReport *_pReportingInterface)
void	Output (Diana::SolverEvents event) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation)
ICapeNumericESO *	GetOldESO ()
Protected Member Functions
Common::Types::CapeBoolean	IsInFittingTimeInterval (Common::Types::CapeDouble dblVal) const
void	StorePointVariable (const Common::Types::CapeArrayDouble &_vars)
Protected Attributes
Diana::IDianaMain *	dianaMain
	Pointer on main singleton object.
Common::Types::CapeString	strSolverLibrary
	Name (path to) solver's library (so-file)
const Common::NLPData::CapeMeasuredData *	pExpData
	Experimental data.
Common::Types::CapeBoolean	isPrepearedStatesMatrix
	Determine weather current state matrix is valid.
DianaNLPFullMatrixDouble	statesMatrix
	Matrix of state variables values collected during calculation of objective function.
Common::Types::CapeArrayLong	statesIndices
	Indices of state variables which will be stored during calculation of objective function.
Common::Types::CapeDouble	dblStartTime
	Beginning of fitting time interval.
Common::Types::CapeDouble	dblEndTime
	Ending of fitting time interval.
Common::Types::CapeBoolean	enabledOutput
	When this flag is true, each CalcObjFunction outputs results to out_stream.
FILE *	out_stream
	If enabledOutput = true, each CalcObjFunction outputs results to this stream.
Common::Types::CapeArrayLong	idxOutStates
	Indices of model's state variables, which values will be additionally outputted in CalcObjFunction.
ICapeNumericESO *	pOldESO
	Old ESO.
ParameterFittingTaskReport *	report
	Reporting interface.
Common::Types::CapeBoolean	bInitialized
	Flag, indicates that optimizer is initialised.

---

Detailed Description

Base class for single-experiment parameter fitting tasks.

---

Constructor & Destructor Documentation

DianaParameterFittingTask	(	const Common::NLPData::CapeMeasuredData *	_expdata,
		Numeric::Solvers::Solver::ICapeNumericSolver *	_solver = NULL,
		Numeric::Solvers::Model::ICapeNumericContinuousModel *	_model = NULL,
		IDianaMain *	_dianaMain = NULL,
		CapeString	_solverName = NULL
	)

Constructor with default parameters iniialization.

virtual ~DianaParameterFittingTask

(

)

[virtual]

Destructor which closes output stream if necessary.

---

Member Function Documentation

void DisableOutput

(

)

Disables output of CalcObjFunction.

void EnableOutput

(

const Common::Types::CapeString &

stream_name

)

throw (Common::Error::ECapeUnknown)

Enables output of CalcObjFunction.

Numeric::Solvers::Eso::ICapeNumericESO* GetActiveESO

(

)

throw (Common::Error::ECapeUnknown) [inline]

Returns pointer to active ESO of initial model.

References DianaParameterFittingTask::pOldESO.

const Common::NLPData::CapeMeasuredData* GetExpData

(

)

throw (Common::Error::ECapeUnknown) [inline]

Returns pointer to experimental data.

References DianaParameterFittingTask::pExpData.

virtual CapeLong GetFixedSoughtParamsCount

(

)

[pure virtual]

Gets number of fixed variables among sought parameters.

Implemented in SensParameterFittingTask, and ParameterFittingTask.

virtual CapeLong GetStateSoughtParamsCount

(

)

[pure virtual]

Gets number of state variables among sought parameters.

Implemented in SensParameterFittingTask, and ParameterFittingTask.

const DianaNLPFullMatrixDouble& GetStoredStates

(

)

[inline]

Gets stored state variables matrix.

References DianaParameterFittingTask::statesMatrix.

Common::Types::CapeBoolean IsInFittingTimeInterval

(

Common::Types::CapeDouble

dblVal

)

const [inline, protected]

Returns true if given vlue is in fitting time interval

Reimplemented in ParameterFittingTask.

References DianaParameterFittingTask::dblEndTime, and DianaParameterFittingTask::dblStartTime.

void Output

(

Diana::SolverEvents

event

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation) [virtual]

Send notification to report hadler

Parameters:

event

- reporting event.

Implements IDianaNLPTaskReporting.

void SetFittingInterval	(	Common::Types::CapeDouble	_startTime,
		Common::Types::CapeDouble	_endTime
	)		throw (Common::Error::ECapeUnknown)

Defines fitting time interval

virtual void SetNLPParameters

(

Parameters::ICapeOptimizationPoint *

_pars

)

throw (Common::Error::ECapeUnknown) [inline, virtual]

Set new fitting parameters values

Reimplemented from DianaNLPTask.

References DianaParameterFittingTask::isPrepearedStatesMatrix.

void SetOutputStateVariables

(

const CapeArrayString &

names

)

Sets names of model's state variables, which values will be additionally outputted in CalcObjFunction.

Parameters:

names

- reference to names of collecting model's state variables.

void SetReportingInterface

(

ParameterFittingTaskReport *

_pReportingInterface

)

Sets task reporting interface

Parameters:

_pReportingInterface

- reporting interface for reference to names of collecting model's state variables.

void SetStoringStateVariables

(

const CapeArrayString &

names

)

Sets names of model's state variables, which values will be stored in Task.

Parameters:

names

- reference to names of collecting model's state variables.

void SetStoringStateVariables

(

const CapeArrayLong &

indices

)

Sets indecies of model's state variables, which values will be stored in Task.

Parameters:

indices

- reference to indices of collecting model's state variables.

void StorePointVariable

(

const Common::Types::CapeArrayDouble &

_vars

)

[inline, protected]

Add current set of selected state variables values

References DianaParameterFittingTask::statesMatrix.

---

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

• DianaParameterFittingTask.hpp