ICapeDiagnostic Interface

Provides a mechanism to provide verbose messages to the user.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#Request Example
[ComImportAttribute]
[GuidAttribute("678c0a9d-0100-11d2-a67d-00105a42887f")]
[ComVisibleAttribute(false)]
public interface ICapeDiagnostic

Remarks

The communication of verbose information from the PMC to the PME (and hence to the user). PMCs should be able to log or display information to the user while it is executing a flowsheet. Rather than each PMC performing these tasks by the means of different mechanisms, it is much preferable to redirect them all to the PME services for communicating with the user. The Error Common Interfaces do not fulfil these requirements, since they stop the execution of the PMC code and signal an abnormal situation to the PME. The document deals with the transferral of simple informative or warning messages.

Methods

LogMessage Writes a string to the PME's log file.
PopUpMessage Writes a message to the terminal.

See Also