MixerExampleProduceReport Method

Produces the active report for the Mixer Example unit operation.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

public override void ProduceReport(
	ref string message
)

VBRequest Example

Public Overrides Sub ProduceReport ( 
	ByRef message As String
)

Parameters

message String

Implements

ICapeUnitReportProduceReport(String)

Remarks

The ProduceReport method creates the active report for the unit operation. The method looks to the selectedReport and generates the required report. If a local report has ben added likne in MixerExample, this method must generate that report.

Example

An example of how to produce a report for a unit operation. In this case, the report can be either "Report 2" defined in the MixerExample or the "Default Report" from CapeUnitBase. If "Default Report" is selected, then the ProduceReport(String) method is called, and the message parameter forwarded. Otherwise, the report is generated in this method. "Default Report" gen.

C#

public override void ProduceReport(ref String message)
{
if (this.selectedReport == "Default Report") base.ProduceReport(ref message);
if (this.selectedReport == "Report 2") message = "This is the alternative Report.";
}

Exceptions

ECapeUnknown	The error to be raised when other error(s), specified for this operation, are not suitable.
ECapeNoImpl	ECapeNoImpl