ParameterFittingTaskReport Class Reference

#include <DianaParameterFittingTask.hpp>

Inheritance diagram for ParameterFittingTaskReport:

List of all members.

Public Member Functions
	ParameterFittingTaskReport (const CapeString &_filename) throw (Common::Error::ECapeUnknown)
	~ParameterFittingTaskReport () throw (Common::Error::ECapeUnknown)
void	Activate ()
void	Deactivate ()
void	Output (Diana::SolverEvents event, DianaParameterFittingTask *task) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation)
void	SetOutputParameters (const Common::Types::CapeArrayString &_strs)
Common::Collection::ICapeCollection *	GetParameters () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl)
void	SetSimulationContext (Common::Identification::ICapeIdentification *simContextManager) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl)
void	Initialize () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder)
void	Terminate () throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeBadInvOrder)
Private Attributes
CapeBoolean	active
	Flag which shows that report is active and it can output data. If it is false, report isn't outputting anything,.
FILE *	plot_pipe
	Output pipe.
CapeBoolean	Initialized
	Start event handled by Report.
CapeString	fname
	Cache for name of the loaded file.
CapeArrayString	outpars
	Parameters for output.
Diana::DianaCollection	collParameters

---

Detailed Description

Represents a report interface for DianaParameterFittingTask.

---

Constructor & Destructor Documentation

ParameterFittingTaskReport

(

const CapeString &

_filename

)

throw (Common::Error::ECapeUnknown)

Initializes a ParameterFittingTaskReport and sets its default parameters.

Parameters:

_filename

- filenames part for files generating by reporting class.

~ParameterFittingTaskReport

(

)

throw (Common::Error::ECapeUnknown)

Destructor which flushes and closes filestream.

---

Member Function Documentation

void Activate

(

)

[inline]

Activate report output.

void Deactivate

(

)

[inline]

Deactivate report output.

Common::Collection::ICapeCollection* GetParameters

(

)

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

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.

Implements ICapeUtilities.

void Initialize

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder) [virtual]

The environment will order the component to get initialised through this method. Any initialisation that could fail must be placed here. Initialise is guaranteed to be the first method called by the client (except low level methods such as class constructors or initialisation persistence methods). Initialise has to be called once when the component is instantiated in a particular flowsheet. When the initialisation 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.

Implements ICapeUtilities.

void Output	(	Diana::SolverEvents	event,
		DianaParameterFittingTask *	task
	)		throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation)

Outputs the given current DianaParameterFittingTask.

Parameters:

event	- type of event occured for the report to manage.
task	- DianaParameterFittingTask to output data from.

void SetOutputParameters

(

const Common::Types::CapeArrayString &

_strs

)

[inline]

Set list of parameters which will be added to a final report

Parameters:

_strs

list of parameters for output

void SetSimulationContext

(

Common::Identification::ICapeIdentification *

simContextManager

)

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

Allows the environment to convey the component a reference to the formers simulation context. The simulation context will be environment objects which will expose a given set of Cape Open interfaces. Each of these interfaces will allow the component to call back the environment in order to benefit from its exposed services (such as creation of material templates, diagnostics or measurement unit conversion). If the component does not support accessing the simulation context, it is recommended to raise the ECapeNoImpl error.

Parameters:

simContextManager

the reference to the environment's simulation context class. For the component to use this class, this reference will have to be converted to each of the defined Cape Open Simulation Context interfaces.

Implements ICapeUtilities.

void Terminate

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources, Common::Error::ECapeBadInvOrder) [virtual]

The environment will order the component to get destroyed through this method. Any uninitialisation that could fail must be placed here. Terminate is guaranteed to be the last method called by the client (except low level methods such as class destructors). Terminate may be called at any time, but may be only called once. When this method returns an error, the environment should report the user. However, after that the environment is not allowed to use the component anymore.

Implements ICapeUtilities.

---

Member Data Documentation

Diana::DianaCollection collParameters [private]

collections of the exported parameters

---

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

• DianaParameterFittingTask.hpp