ConfigurationTransferType – OPC UA for Machine Vision – Part 1: Control, configuration management, recipe management, result management

7.4 ConfigurationTransferType

7.4.1 Overview

This ObjectType is a subtype of the TemporaryFileTransferType defined in OPC 10000-5 and is used to transfer configuration data as a file.

The ConfigurationTransferType overwrites the Methods GenerateFileForRead and GenerateFileForWrite to specify the concrete type of the generateOptions Parameter of the Methods.

Figure 11 shows the hierarchical structure and details of the composition. It is formally defined in Table 25.

Figure 11 – Overview ConfigurationTransferType

Table 25 – Definition of ConfigurationTransferType

Attribute	Value
BrowseName	ConfigurationTransferType
IsAbstract	False

References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the TemporaryFileTransferType defined in OPC 10000-5
HasComponent	Method	0:GenerateFileForRead	--	--	Mandatory
HasComponent	Method	0:GenerateFileForWrite	--	--	Mandatory

7.4.2 ConfigurationTransferType methods

7.4.2.1 GenerateFileForRead

This method is used to start the read file transaction. A successful call of this method creates a temporary FileType Object with the file content and returns the NodeId of this Object and the file handle to access the Object.

Signature

	GenerateFileForRead ([in]	ConfigurationTransferOptions	generateOptions[out]	NodeId	fileNodeId[out]	UInt32	fileHandle[out]	NodeId	completionStateMachine);

Table 26 – GenerateFileForRead Method Arguments

Argument	Description
generateOptions	The structure used to define the generate options for the file.
fileNodeId	NodeId of the temporary file
fileHandle	The FileHandle of the opened TransferFile. The FileHandle can be used to access the TransferFile methods Read and Close.
completionStateMachine	If the creation of the file is completed asynchronously, the parameter returns the NodeId of the corresponding FileTransferStateMachineType Object. If the creation of the file is already completed, the parameter is null. If a FileTransferStateMachineType object NodeId is returned, the Read Method of the file fails until the TransferState changed to ReadTransfer.

Table 27 – GenerateFileForRead Method AddressSpace Definition

Attribute	Value
BrowseName	GenerateFileForRead

References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
HasProperty	Variable	InputArguments	Argument[]	PropertyType	Mandatory
HasProperty	Variable	OutputArguments	Argument[]	PropertyType	Mandatory

7.4.2.2 GenerateFileForWrite

This method is used to start the write file transaction. A successful call of this method creates a temporary FileType Object with the file content and returns the NodeId of this Object and the file handle to access the Object.

Signature

	GenerateFileForWrite ([in]	ConfigurationTransferOptions	generateOptions[out]	NodeId	fileNodeId[out]	UInt32	fileHandle);

Table 28 – GenerateFileForWrite Method Arguments

Argument	Description
generateOptions	The structure used to define the generate options for the file.
fileNodeId	NodeId of the temporary file.
fileHandle	The fileHandle of the opened TransferFile. The fileHandle can be used to access the TransferFile methods Write and CloseAndCommit.

Table 29 – GenerateFileForWrite Method AddressSpace Definition

Attribute	Value
BrowseName	GenerateFileForWrite

References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
HasProperty	Variable	InputArguments	Argument[]	PropertyType	Mandatory
HasProperty	Variable	OutputArguments	Argument[]	PropertyType	Mandatory