FC_EuclideanDistance3D

FC_EuclideanDistance3D - General Information

Overview

Type:	Function
Available as of:	V1.0.3.0
Versions:	Current version

Task

Calculates the Euclidean distance between two points in the 3-dimensional space.

Description

Calculates the Euclidean distance between two points in the 3-dimensional space, which are given by their position vectors. The Euclidean distance is defined to be the square root of the sum of the squares of the elements of the vector.

Interface

Input	Data type	Description
i_stV1	ST_Vector3D	Position vector of point 1
i_stV2	ST_Vector3D	Position vector of point 2

Output	Data type	Description
q_etDiag	GD.ET_Diag	General library-independent statement on the diagnostic. A value not equal to ET_Diag.Ok corresponds to an 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

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic.

A value not equal to ET_Diag.Ok corresponds to an 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

Return Value

Data type	Description
LREAL	Euclidean distance between the points represented by the position vectors i_stV1 and i_stV2.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The distance has been calculated successfully.