MemoryReportingInterface Class Reference

Inheritance diagram for MemoryReportingInterface:

List of all members.

Public Member Functions
const Common::Types::CapeString &	GetComponentName () const throw (Common::Error::ECapeUnknown)
void	SetComponentName (const Common::Types::CapeString &_name) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
const Common::Types::CapeString &	GetComponentDescription () const throw (Common::Error::ECapeUnknown)
void	SetComponentDescription (const Common::Types::CapeString &_description) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
void	Add (Common::Parameter::ICapeParameter *_parameter) throw (Common::Error::ECapeUnknown)
Common::Types::CapeLong	getIndexByItem (Common::Parameter::ICapeParameter *_parameter) throw (Common::Error::ECapeUnknown)
void	Remove (Common::Parameter::ICapeParameter *_parameter) throw (Common::Error::ECapeUnknown)
void	Remove (Common::Types::CapeLong index) throw (Common::Error::ECapeUnknown)
void	ClearData () throw (Common::Error::ECapeUnknown)
void	StartNewChunk () throw (Common::Error::ECapeUnknown)
void	WriteData (const Common::Types::CapeString &filename, const Common::Types::CapeString &format="") throw (Common::Error::ECapeUnknown)
void	WriteDataMatlab (const Common::Types::CapeString &filename) throw (Common::Error::ECapeUnknown)
void	WriteDataPlain (const Common::Types::CapeString &filename) throw (Common::Error::ECapeUnknown)
void	WriteDataCSV (const Common::Types::CapeString &filename) throw (Common::Error::ECapeUnknown)
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)
void	onSolverEvent (SolverEvents event, IDianaNumericSolver *_solver) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation)
Protected Member Functions
ReportDataEntry *	getItem (Common::Types::CapeLong index) throw (Common::Error::ECapeUnknown)
ReportDataEntry *	getItem (Common::Parameter::ICapeParameter *_parameter) throw (Common::Error::ECapeUnknown)
void	shutdownReportingInterface ()
void	setSolver (Diana::IDianaNumericSolver *_solver) throw (Common::Error::ECapeUnknown)
void	addDimension () throw (Common::Error::ECapeUnknown)
virtual void	solverStart ()
virtual void	solverStep ()
virtual void	solverStop ()
virtual void	updateValues ()
virtual void	solverError ()
Protected Attributes
std::map < Common::Parameter::ICapeParameter *, Common::Types::CapeLong >	pmap
	mapping from the parameter item to the ReportDataEntry index in the vector values
std::vector< ReportDataEntry >	values
Diana::IDianaNumericSolver *	solver
Common::Types::CapeString	name
Common::Types::CapeString	description
Diana::DianaCollection	collParameters
	collections of the exported parameters

---

Member Function Documentation

const Common::Types::CapeString& GetComponentDescription

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

gets the description of the component.

Implements ICapeIdentification.

const Common::Types::CapeString& GetComponentName

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

gets the name of the component.

Implements ICapeIdentification.

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 SetComponentDescription

(

const Common::Types::CapeString &

_description

)

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

sets the description of the component.

Parameters:

_description

the description of the component

Implements ICapeIdentification.

void SetComponentName

(

const Common::Types::CapeString &

_name

)

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

sets the name of the component.

Parameters:

_name

the name of the component

Implements ICapeIdentification.

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.

---

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

• DianaReporting.hpp