Machinery Result Transfer - 10 OPC UA DataTypes

This abstract structure contains information on which ResultFile should be provided to be transferred to the Client. The structure contains the ResultId of the requested result. Companion Specifications and vendors shall either subtype this structured DataType to provide more information about the provided ResultFile, like the file format, or use an existing subtype like ResultTransferOptionsDataType. The structure is defined in Table 18.

Table 18 – BaseResultTransferOptionsDataType Structure

Name	Type	Description
BaseResultTransferOptionsDataType	structure
ResultId	0:TrimmedString	The Id of the result to be transferred to the Clients

Its representation in the AddressSpace is defined in Table 19.

Table 19 – BaseResultTransferOptionsDataType Definition

Attribute	Value
BrowseName	BaseResultTransferOptionsDataType
IsAbstract	True
Description	Abstract type containing information which file should be provided.
References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of 0:Structure defined in OPC 10000-5
Conformance Units
Machinery-Result Types

10.2 ResultTransferOptionsDataType

This structure contains information on which ResultFile should be provided to be transferred to the Client. The structure is a concrete DataType that can be used directly if no additional information needs to be added. No additional fields have been added to the structure.

Its representation in the AddressSpace is defined in Table 20.

Table 20 – ResultTransferOptionsDataType Definition

Attribute	Value
BrowseName	ResultTransferOptionsDataType
IsAbstract	False
Description	Contains information which file should be provided.
References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of BaseResultTransferOptionsDataType
Conformance Units
Machinery-Result Types

10.3 ResultEvaluationEnum

This enumeration ResultEvaluationEnum indicates whether a result was in tolerance. The enumeration is defined in Table 21.

Table 21 – ResultEvaluationEnum Items

Name	Value	Description
Undefined	0	The evaluation of the result is unknown, for example because it failed
OK	1	The result is in tolerance
NotOK	2	The result is out of tolerance
NotDecidable	3	The decision is not possible due to measurement uncertainty.

Its representation in the AddressSpace is defined in Table 22.

Table 22 – ResultEvaluationEnum Definition

Attribute	Value
BrowseName	ResultEvaluationEnum
IsAbstract	False
Description	Indicates whether a result was in tolerance
References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable	0:EnumValues	0:EnumValueType[]	0:PropertyType
Conformance Units
Machinery-Result Types

10.4 ProcessingTimesDataType

This structure contains measured times that were generated during the execution of a recipe. These measured values provide information about the duration required by the various sub-functions The structure is defined in Table 23.

Table 23 – ProcessingTimesDataType Structure

Name	Type	Description	Optional
ProcessingTimesDataType	structure
StartTime	0:UtcTime	Contains the time when the system started execution of the recipe.	False
EndTime	0:UtcTime	Contains the time when the system finished (or stopped/aborted) execution of the recipe.	False
AcquisitionDuration	0:Duration	Time spent by the system acquiring data.	True
ProcessingDuration	0:Duration	Time spent by the system processing data.	True

Its representation in the AddressSpace is defined in Table 24.

Table 24 – ProcessingTimesDataType Definition

Attribute	Value
BrowseName	ProcessingTimesDataType
IsAbstract	False
Description	Contains measured times that were generated during the execution of a recipe.
References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of 0:Structure defined in OPC 10000-5
Conformance Units
Machinery-Result Types

10.5 ResultDataType

This structure contains fields that were created during the execution of a recipe. A result may be a total or a partial result, which is defined by the value of the property IsPartial. The structure of the ResultContent which is generated by the system is application-specific and not defined at this time. If no ResultContent is available, the array of ResultContent shall be empty.

The structure is defined in Table 25.

Table 25 – ResultDataType Structure

Name	Type	Description	AllowSubtypes
ResultDataType	structure
ResultMetaData	ResultMetaDataType	Contains meta data describing the ResultContent	True
ResultContent	0:BaseDataType[]	Abstract data type to be subtyped from to hold result data created by the selected recipe.	False

Its representation in the AddressSpace is defined in Table 26.

Table 26 – ResultDataType Definition

Attribute	Value
BrowseName	ResultDataType
IsAbstract	False
Description	Contains fields that were created during the execution of a recipe.
References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of 0:Structure defined in OPC 10000-5
Conformance Units
Machinery-Result Types

10.6 ResultMetaDataType

This structure contains meta data of a result, describing the result. The structure is defined in Table 27.

Table 27 – ResultMetaDataType Structure

Name	Type	Description	Optional
ResultMetaDataType	structure
ResultId	0:TrimmedString	System-wide unique identifier, which is assigned by the system. This ID can be used for fetching exactly this result using the method GetResultById and it is identical to the ResultId of the ResultReadyEventType. If the system does not manage ResultIds, it should always be set to “NA”.	False
HasTransferableDataOnFile	0:Boolean	Indicates that additional data for this result can be retrieved by temporary file transfer. If not provided, it is assumed that no file is available.	True
IsPartial	0:Boolean	Indicates whether the result is the partial result of a total result. When not all samples are finished yet the result is 'partial'. If not provided, it is assumed to be a total result.	True
IsSimulated	0:Boolean	Indicates whether the result was created in simulation mode. Simulation mode implies that the result is only generated for testing purposes and not based on real production data. If not provided, it is assumed to not be simulated.	True
ResultState	0:Int32	ResultState provides information about the current state of the process or measurement creating a result. Applications may use negative values for application-specific states. All other values shall only be used as defined in the following: 0 – Undefined initial value 1 – Completed: Processing was carried out completely 2 – Processing: Processing has not been finished yet 3 – Aborted: Processing was stopped at some point before completion 4 – Failed: Processing failed in some way.	True
StepId	0:TrimmedString	Identifies the step which produced the result. Although the system-wide unique JobId would be sufficient to identify the job which the result belongs to, this makes for easier filtering without keeping track of JobIds. This specification does not define how the StepId is transmitted to the system. Typically, it is provided by the Client when starting an execution.	True
PartId	0:TrimmedString	Identifies the part used to produce the result. Although the system-wide unique JobId would be sufficient to identify the job which the result belongs to, this makes for easier filtering without keeping track of JobIds. This specification does not define how the PartId is transmitted to the system. Typically, it is provided by the Client when starting the job.	True
ExternalRecipeId	0:TrimmedString	External ID of the recipe in use which produced the result. The External ID is managed by the environment. This specification does not define how the ExternalRecipeId is transmitted to the system. Typically, it is provided by the Client.	True
InternalRecipeId	0:TrimmedString	Internal ID of the recipe in use which produced the result. This ID is system-wide unique and it is assigned by the system.	True
ProductId	0:TrimmedString	Identifies the product used to produce the result. This specification does not define how the productId is transmitted to the system. Typically, it is provided by the Client.	True
ExternalConfigurationId	0:TrimmedString	External ID of the Configuration in use while the result was produced. It is managed by the Environment. This specification does not define how the ExternalConfigurationId is transmitted to the system. Typically, it is provided by the Client.	True
InternalConfigurationId	0:TrimmedString	Internal ID of the Configuration in use while the result was produced. This ID is system-wide unique and it is assigned by the system.	True
JobId	0:TrimmedString	Identifies the job which produced the result. This ID is system-wide unique and it is assigned by the system.	True
CreationTime	0:UtcTime	CreationTime indicates the time when the result was created. Creation time on the measurement system (not the receive time of the Server). It is recommended to always provide the CreationTime.	True
ProcessingTimes	ProcessingTimesDataType	Collection of different processing times that were needed to create the result.	True
ResultUri	0:UriString[]	Path to the actual measured result, managed external to the Server.	True
ResultEvaluation	ResultEvaluationEnum	The ResultEvaluation indicates whether the result was in tolerance.	True
ResultEvaluationCode	0:Int64	Vendor-specific code describing more details on ResultEvaluation.	True
ResultEvaluationDetails	0:LocalizedText	The ResultEvaluationDetails provides high level status information in a user-friendly text. This can be left empty for successful operations.	True
FileFormat	0:String[]	The format in which the measurement results are available (e.g. QDAS, CSV, …) using the ResultTransfer Object. If multiple file formats are provided, the GenerateFileForRead of ResultTransfer should contain corresponding generateOptions, to select the file format. This specification does not define those generateOptions.	True

Its representation in the AddressSpace is defined in Table 28.

Table 28 – ResultMetaDataType Definition

Attribute	Value
BrowseName	ResultMetaDataType
IsAbstract	False
Description	Meta data of a result, describing the result.
References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of 0:Structure defined in OPC 10000-5
Conformance Units
Machinery-Result Types