FB_SendVisionDataClient - SetNextProduct (Method)

Overview

Type:	Method
Available as of:	V1.7.3.0

This chapter provides information on:

Task
Description
Interface
Diagnostic Messages

Task

Set the data of one product.

Description

With the method SetNextProduct, the data of one product can be set.

Interface

Input	Data type	Description
i_uiObjectType	UINT	Object type of the product.
i_uiIndex	UINT	Protocol index of header.
i_stPosition	PDL.ST_Vector3D	Position of the product.
i_lrRotation	LREAL	Rotation of the product.
i_lrScale	LREAL	Scale of the product.
i_lrQuality	LREAL	Quality of the product.
i_sUserString	STRING[80]	User string to send with the product data.

Output	Data type	Description
q_etDiag	GD.ET_Diag	General library-independent statement on the diagnostic. A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.
q_etDiagExt	ET_DiagExt	POU-specific output on the diagnostic. q_etDiag = ET_Diag.Ok -> Status message q_etDiag <> ET_Diag.Ok -> Diagnostic message
q_sMsg	STRING[80]	Event-triggered message that gives more detailed information on the diagnostic state.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic. A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Diagnostic message

q_sMsg

STRING[80]

Event-triggered message that gives more detailed information on the diagnostic state.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value of q_etDiagExt	Description
Ok	Ok	0	Ok
ExecutionAborted	NoDataAvailable	14	No data available.
InputParameterInvalid	IndexRange	28	Index out of range.
InputParameterInvalid	ObjectTypeRange	27	Object ID out of range.
LimitReached	ProductsPerProtocolExceeded	19	Maximum number of products per protocol exceeded.
LimitReached	ProtocolLengthExceeded	15	The length of the protocol has been exceeded.

IndexRange

Enumeration name:	IndexRange
Enumeration value:	28
Description:	Index is out of range.

Issue	Cause	Solution
Index is out of range.	The index is 0.	Verify that the index is not 0.

NoDataAvailable

Enumeration name:	NoDataAvailable
Enumeration value:	14
Description:	No data available.

Issue	Cause	Solution
No data available.	Product data can only be set after header data has been set.	Verify that the method SetHeader(...) was called successfully before setting product data.

ObjectTypeRange

Enumeration name:	ObjectTypeRange
Enumeration value:	27
Description:	Object type is out of range.

Issue	Cause	Solution
Object type is out of range.	The object type is 0.	Verify that the object type is not 0.

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Success

Status message: Setting the data of one product was successful.

ProductsPerProtocolExceeded

Enumeration name:	ProductsPerProtocolExceeded
Enumeration value:	19
Description:	Maximum number of products per protocol exceeded.

Issue	Cause	Solution
Maximum number of products per protocol exceeded.	The maximum number of products per protocol has been exceeded.	Verify that the maximum number of products per protocol is less than or equal to Gc_uiMaxNumberOfProductsPerProtocol.

ProtocolLengthExceeded

Enumeration name:	ProtocolLengthExceeded
Enumeration value:	15
Description:	The length of the protocol has been exceeded.

Issue	Cause	Solution
The length of the protocol has been exceeded.	The length of the protocol to send to the server exceeds the value of Gc_uiMaxLengthOfProtocol.	Adapt the parameter Gc_uiMaxLengthOfProtocol. Split the content of the protocol and send it in several protocols.

Issue

Cause

Solution

The length of the protocol has been exceeded.

The length of the protocol to send to the server exceeds the value of Gc_uiMaxLengthOfProtocol.

Adapt the parameter Gc_uiMaxLengthOfProtocol.

Split the content of the protocol and send it in several protocols.