ICapeIdentification Interface

As illustration, we remind requirements coming from the existing interface specification and being connected with the Identification concept:

The Unit Operations Interfaces have the following requirements:

* If a flowsheet contains two instances of a Unit Operation of a particular class, the COSE needs to provide the user a textual identifier to distinguish each of the instances. For instance, when the COSE requires to report about an error occurred in one of the Unit Operations.

* When the COSE shows the user its GUI to connect the COSE’s streams to the Unit Operation ports, the COSE needs to request the Unit for its list of available ports. For the user to identify the ports, the user needs some distinctive textual information for each of them.

* When the COSE exposes to the user its interfaces to browse or set the value of an internal parameter of a Unit Operation, the COSE needs to request the Unit for its list of available parameters. No matter if this COSE’s interface is a GUI or a programming interface, each parameter must be identified by a textual string.

The ICapeThermoMaterialObject (used by both Unit and Thermo interfaces):

* If a Unit Operation has encountered an error accessing a stream (ICapeThermoMaterialObject), the Unit might decide to report it to the user. It would be desirable the stream to have a textual identifier for the user to be able to quickly know which stream failed.

The Thermodynamic Interfaces have the following requirements:

* The ICapeThermoSystem and the ICapeThermoPropertyPackage interfaces don’t require an identification interface, since both of them have been designed as singletons (a single instance of each component class is required). That means that there is no need to identify this instance: its class description would be enough. However, the user might decide anyway to assign a name or a description to the CAPE-OPEN property systems or property packages used in her/his flowsheet. Furthermore, if these interfaces evolve, the singleton approach could be removed. In this case, identifying each instance will be a must.

The Solvers Interfaces have the following requirements:

* Many objects should provide the functionality coming from the Identification Common Interface.

The SMST Interfaces have the following requirements:

* The CO SMST component package depends on the Identification Interface package. The interface ICapeSMSTFactory must provide the Identification capabilities.

Reference document: Identification Common Interface

Reference