All Methods defined for AnalyserChannelType and its substate machines are grouped under the MethodSet component inherited from TopologyElementType [OPC 10000-100].

AnalyserChannel defines a Method called StartSingleAcquisition, which is used to start a single data acquisition, which uses current values of Parameters from the AcquisitionSettings FunctionalGroup of the Stream indicated by SelectedStream argument. The Method argument ExecutionCycle is used to indicate what it is that the acquisition is collecting e.g. sample, background, and dark noise.

If an error occurs during a method call, the analyser state should be the same as before the call.

Table 20 StartSingleAcquisition Method

Method

Description

StartSingleAcquisition

Start collection of a single sample or reference data

InputArguments

Name

DataType

ValueRank / arrayDimension

Description

ExecutionCycle

ExecutionCycleEnumeration

-1/[0]

Enumeration which specifies the type of the acquisition cycle (e.g. Calibration, Sampling )

ExecutionCycleSubcode

UInteger

-1/[0]

Vendor defined code, which further describes the acquisition cycle. This code should correspond to one of the enumeration codes defined for ExecutionCycleSubcode Parameter in the AcquisitionStatus FunctionalGroup on a Stream.

SelectedStream

String

-1/[0]

Browse name of the target Stream for this acquisition

OutputArguments: NONE

Table 21 - GotoOperating Method

Method

Description

GotoOperating

Causes the AnalyserChannelStateMachine to go to Operating state..

InputArguments: NONE

OutputArguments: NONE

Table 22 - GotoMaintenance Method

Method

Description

GotoMaintenance

Causes the AnalyserChannelStateMachine to go to Maintenance state.

InputArguments: NONE

OutputArguments: NONE

Table 23 - Reset Method

Method

Description

Reset

Causes transition to the Resetting state.

InputArguments: NONE

OutputArguments: NONE

Table 24 - Start Method

Method

Description

Start

Causes transition to the Starting state.

InputArguments: NONE

OutputArguments: NONE

Table 25 - Stop Method

Method

Description

Stop

Causes transition to the Stopping state.

InputArguments: NONE

OutputArguments: NONE

Table 26 - Hold Method

Method

Description

Hold

Causes transition to the Holding state.

InputArguments: NONE

OutputArguments: NONE

Table 27 - Unhold Method

Method

Description

Unhold

Causes transition to the Unholding state.

InputArguments: NONE

OutputArguments: NONE

Table 28 - Suspend Method

Method

Description

Suspend

Causes transition to the Suspending state.

InputArguments: NONE

OutputArguments: NONE

Table 29 - Unsuspend Method

Method

Description

Unsuspend

Causes transition to the Unsuspending state.

InputArguments: NONE

OutputArguments: NONE

Table 30 - Abort Method

Method

Description

Abort

Causes transition to the Aborting state.

InputArguments: NONE

OutputArguments: NONE

Table 31 - Clear Method

Method

Description

Clear

Causes transition to the Clearing state.

InputArguments: NONE

OutputArguments: NONE

Table 32 - Method result codes for AnalyserChannelType methods

Result code

Description

Bad_InvalidArgument

One or more argument re invalid.

Bad_InvalidState

Method called when the analyser is not in the appropriate state on one of its state machines.

Bad_RequestTooLarge

The request message size exceeds limits set by the analyser; the ConfigData is too big.

Bad_ResponseTooLarge

The response message size exceeds limits set by the client; the ConfigData is too big.

Bad_ServiceUnsupported

The analyser does not support the requested service.

Bad_UnexpectedError

An unexpected error occurred.