ObjectTypes for data transfer and management – OPC UA for Wireless Machine Tool Peripherals

7.2 ObjectTypes for data transfer and management

7.2.1 WMTPWorkCycleDataType ObjectType Definition

The WMTPWorkCycleDataType provides the Methods that are required for reading out and deleting the work cycle data of a WMTP. It is formally defined in Table 27.

Table 27 – WMTPWorkCycleDataType Definition

Attribute	Value
BrowseName	WMTPWorkCycleDataType
IsAbstract	False

References	Node Class	BrowseName	Other
Subtype of the BaseObjectType defined in OPC 10000-5
0:HasComponent	Method	DeleteAllStoredRecords	O
0:HasComponent	Method	DeleteStoredRecordsTime	O
0:HasComponent	Method	DeleteStoredRecordsIndex	O
0:HasComponent	Method	AbortOperation	M
0:HasComponent	Method	ReportNumberOfStoredRecords	M
0:HasComponent	Method	ReportNumberOfStoredRecordsTime	O
0:HasComponent	Method	CombinedReportAll	M
0:HasComponent	Method	CombinedReportIndex	O
0:HasComponent	Method	CombinedReportTime	O
0:HasComponent	Method	CombinedReportLastValue	O
0:HasComponent	Method	CombinedReportFirstValue	O

Conformance Units
WMTP WorkCycleData Deleting All
WMTP WorkCycleData Deleting Advanced
WMTP WorkCycleData ReportNumberOfStoredRecordsTime
WMTP WorkCycleData CombinedReport Index
WMTP WorkCycleData CombinedReport Time
WMTP WorkCycleData CombinedReport Advanced

DeleteAllStoredRecords enables to permanently delete all stored data from the WMTP.

DeleteStoredRecordsTime enables to permanently delete a desired section of stored data from the WMTP, chosen by the time of measurement.

DeleteStoredRecordsIndex enables to permanently delete a desired section of stored data from the WMTP, chosen by the index of measurement.

AbortOperation enables the termination of the process currently being executed by the WMTP. This is necessary as some transfer processes can take several minutes.

ReportNumberOfStoredRecords enables querying the number of data records available on the WMTP.

ReportNumberOfStoredRecordsTime enables querying the number of data records available on the WMTP according to a given timespan.

CombinedReportAll enables to request all stored data from the WMTP.

CombinedReportIndex enables to request the stored data from the WMTP according to the index of the measurements. Using this method, it is possible to request the entire data set as well as desired sections.

CombinedReportTime enables to request the stored data from the WMTP according to the timestamp of the measurements. Using this method, it is possible to request the entire data set as well as desired sections.

7.2.2 WMTPServiceCycleDataType ObjectType Definition

The WMTPServiceCycleDataType provides the Methods that are required for reading out and deleting the service cycle data of a WMTP. It is formally defined in Table 28.

Table 28 – WMTPServiceCycleDataType Definition

Attribute	Value
BrowseName	WMTPServiceCycleDataType
IsAbstract	False

References	Node Class	BrowseName	Other
Subtype of the BaseObjectType defined in OPC 10000-5
0:HasComponent	Method	DeleteAllStoredRecords	O
0:HasComponent	Method	DeleteStoredRecordsTime	O
0:HasComponent	Method	DeleteStoredRecordsIndex	O
0:HasComponent	Method	AbortOperation	M
0:HasComponent	Method	ReportNumberOfStoredRecords	M
0:HasComponent	Method	ReportNumberOfStoredRecordsTime	O
0:HasComponent	Method	CombinedReportAll	M
0:HasComponent	Method	CombinedReportIndex	O
0:HasComponent	Method	CombinedReportTime	O
0:HasComponent	Method	CombinedReportLastValue	O
0:HasComponent	Method	CombinedReportFirstValue	O

Conformance Units
WMTP ServiceCycleData Deleting All
WMTP ServiceCycleData Deleting Advanced
WMTP ServiceCycleData ReportNumberOfStoredRecordsTime
WMTP ServiceCycleData CombinedReport Index
WMTP ServiceCycleData CombinedReport Time
WMTP ServiceCycleData CombinedReport Advanced

DeleteStoredAllRecords enables to permanently delete all stored data from the WMTP. Using this method, it is possible to remove the entire data set as well as desired sections.

DeleteStoredRecordsTime enables to permanently delete a desired section of stored data from the WMTP, chosen by the time of measurement.

DeleteStoredRecordsNumber enables to permanently delete a desired section of stored data from the WMTP, chosen by the index of measurement.

AbortOperation enables the termination of the process currently being executed by the WMTP. This is necessary as some transfer processes can take several minutes.

ReportNumberOfStoredRecords enables querying the number of data records available on the WMTP.

ReportNumberOfStoredRecordsTime enables querying the number of data records available on the WMTP according to a given timespan.

CombinedReportAll enables to request all stored data from the WMTP.

7.2.3 Methods used for data transfer and management

7.2.3.1 DeleteAllStoredRecords

The Method DeleteAllStoredRecords enables to permanently delete all stored data from the WMTP. Using this method, it is possible to remove the entire data set. The signature of this Method is specified below.

Signature

	DeleteAllStoredRecords (
	);

7.2.3.2 DeleteStoredRecordsTime

The Method DeleteStoredRecordsTime enables to permanently delete the stored data from the WMTP from a specific given time. The signature of this Method is specified below.

Signature

	DeleteStoredRecordsTime (
		[in]	0:DateTime	FromTimestamp,
		[in]	0:DateTime	ToTimestamp,
	);

Table 29 – DeleteStoredRecordsTime Method Arguments

Argument	Description
FromTimestamp	This timestamp defines the start of the time interval that is to be deleted
ToTimestamp	This timestamp defines the end of the time interval that is to be deleted

Table 30 – DeleteStoredRecordsTime Method AddressSpace Definition

Attribute	Value
BrowseName	DeleteStoredRecordsTime

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	InputArguments	Argument[]	0:PropertyType	M

7.2.3.3 DeleteStoredRecordsIndex

The Method DeleteStoredRecordsIndex enables to permanently delete the stored data from the WMTP from a specific given time. The signature of this Method is specified below.

Signature

	DeleteStoredRecordsIndex (
		[in]	0:UInt32	FromIndex,
		[in]	0:UInt32	ToIndex,
	);

Table 31 – DeleteStoredRecordsIndex Method Arguments

Argument	Description
FromIndex	This number defines the index of the first stored value of the interval that is to be deleted
ToIndex	This number defines the index of the last stored value of the interval that is to be deleted

Table 32 – DeleteStoredRecordsIndex Method AddressSpace Definition

Attribute	Value
BrowseName	DeleteStoredRecordsIndex

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	InputArguments	Argument[]	0:PropertyType	M

7.2.3.4 AbortOperation

The Method AbortOperation enables the termination of the process currently being executed by the WMTP. This is necessary as some transfer processes can take several minutes. The signature of this Method is specified below.

Signature

	AbortOperation (
	);

7.2.3.5 ReportNumberOfStoredRecords

The Method ReportNumberOfStoredRecords enables to report how many records are currently stored at the WMTP.

Signature

	ReportNumberOfStoredRecords (
		[out]	0:UInt32	NumberOfStoredRecords);

Table 33 – ReportNumberOfStoredRecords Method Arguments

Argument	Description
NumberOfStoredRecords	Describes the number of currently stored values on the WMTP.

Table 34 – ReportNumberOfStoredRecords Method AddressSpace Definition

Attribute	Value
BrowseName	ReportNumberOfStoredRecords

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	OutputArguments	Argument[]	0:PropertyType	M

7.2.3.6 ReportNumberOfStoredRecordsTime

The Method ReportNumberOfStoredRecordsTime enables to report how many records are currently stored at the WMTP in a specific timespan.

Signature

	ReportNumberOfStoredRecordsTime (
		[in]	0:DateTime	FromTimestamp,
		[in]	0:DateTime	ToTimestamp,
		[out]	0:UInt32	NumberOfStoredRecords);

Table 35 – ReportNumberOfStoredRecordsTime Method Arguments

Argument	Description
FromTimestamp	This timestamp defines the time of the first stored value of the interval that is to be accessed.
ToTimestamp	This timestamp defines the time of the last stored value of the interval that is to be accessed.
NumberOfStoredRecords	Describes the number of currently stored values on the WMTP in the timespan.

Table 36 – ReportNumberOfStoredRecordsTime Method AddressSpace Definition

Attribute	Value
BrowseName	ReportNumberOfStoredRecordsTime

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	InputArguments	Argument[]	0:PropertyType	M
0:HasProperty	Variable	OutputArguments	Argument[]	0:PropertyType	M

7.2.3.7 CombinedReportAll

The Method CombinedReportAll enables access to the entire data set stored on the WMTP. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportAll (
		[out]	WMTPOutputDataType[]	CombinedReport
	);

Table 37 – CombinedReportAll Method Arguments

Argument	Description
CombinedReport	This output argument is carrying the Variables of the DataType WMTPOutputDataType that are requested

Table 38 – CombinedReportAll Method AddressSpace Definition

Attribute	Value
BrowseName	CombinedReportAll

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	OutputArguments	Argument[]	0:PropertyType	M

NOTE: If all measured values exceed the maximum size of an OPC UA message, this method cannot be used. In this case, the data should be queried in packets, for example using the CombinedReportIndex.

7.2.3.8 CombinedReportIndex

The Method CombinedReportIndex enables access to the entire data set stored on the WMTP based on the index of the measurements. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportIndex (
		[in]	0:UInt32	FromIndex,
		[in]	0:UInt32	ToIndex,
		[out]	WMTPOutputDataType[]	CombinedReport
	);

Table 39 – CombinedReportIndex Method Arguments

Argument	Description
FromIndex	This number defines the index of the first stored value of the interval that is to be accessed
ToIndex	This number defines the index of the last stored value of the interval that is to be accessed
CombinedReport	This output argument is carrying the Variables of the DataType WMTPOutputDataType that are requested

Table 40 – CombinedReportIndex Method AddressSpace Definition

Attribute	Value
BrowseName	CombinedReportIndex

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	InputArguments	Argument[]	0:PropertyType	M
0:HasProperty	Variable	OutputArguments	Argument[]	0:PropertyType	M

7.2.3.9 CombinedReportLastValue

The Method CombinedReportLastValue enables access to the last measurement stored on the WMTP. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportLastValue (
		[out]	WMTPOutputDataType	CombinedReport
	);

Table 41 – CombinedReportLastValue Method Arguments

Argument	Description
CombinedReport	This output argument is carrying the Variables of the DataType WMTPOutputDataType that are requested

Table 42 – CombinedReportLastValue Method AddressSpace Definition

Attribute	Value
BrowseName	CombinedReportLastValue

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	OutputArguments	Argument[]	0:PropertyType	M

7.2.3.10 CombinedReportFirstValue

The Method CombinedReportFirstValue enables access to the first measurement stored on the WMTP. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportFirstValue (
		[out]	WMTPOutputDataType	CombinedReport
	);

Table 43 – CombinedReportFirstValue Method Arguments

Argument	Description
CombinedReport	This output argument is carrying the Variables of the DataType WMTPOutputDataType that are requested

Table 44 – CombinedReportFirstValue Method AddressSpace Definition

Attribute	Value
BrowseName	CombinedReportFirstValue

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	OutputArguments	Argument[]	0:PropertyType	M

7.2.3.11 CombinedReportTime

The Method CombinedReportTime enables access to the entire data set stored on the WMTP based on the timestamp of the measurements. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportTime (
		[in]	0:DateTime	FromTimestamp,
		[in]	0:DateTime	ToTimestamp,
		[out]	WMTPOutputDataType[]	CombinedReport
	
	);

Table 45 – CombinedReportTime Method Arguments

Argument	Description
FromTimestamp	This timestamp defines the time of the first stored value of the interval that is to be accessed
ToTimestamp	This timestamp defines the time of the last stored value of the interval that is to be accessed
CombinedReport	This output argument is carrying the Variables of the DataType WMTPOutputDataType that are requested

Table 46 – CombinedReportTime Method AddressSpace Definition

Attribute	Value
BrowseName	CombinedReportTime

References	Node Class	BrowseName	DataType	TypeDefinition	Other
0:HasProperty	Variable	InputArguments	Argument[]	0:PropertyType	M
0:HasProperty	Variable	OutputArguments	Argument[]	0:PropertyType	M