Machine Expert > V2.1 > Logiciel > Bibliothèques, Modèles et Exemples > Bibliothèques > Application Libraries > GeoMath Library Guide > Functions > FC_Vector2DEqual - General Information

FC_Vector2DEqual - General Information

Overview

Type:

Function

Available as of:

V1.0.0.0

Versions:

Current version

This chapter provides information on:

Description

Given two 2D input vectors, the function returns TRUE if their element-wise difference is within the range [-i_lrEps ... i_lrEps], otherwise FALSE.

Interface

Input

Data type

Description

i_stVectorA

SE_MATH.ST_Vector2D

A 2D vector.

i_stVectorB

SE_MATH.ST_Vector2D

A 2D vector.

i_lrEps

LREAL

A reference value used in the comparison.

Output

Data type

Description

q_xError

BOOL

If this output is set to TRUE, an error has been detected. For details, refer to q_etResult and q_etResultMsg.

q_etResult

ET_Result

Provides diagnostic and status information.

If q_xError = FALSE, then q_etResult provides status information.

If q_xError = TRUE, then q_etResult provides diagnostic/error information.

The enumeration ET_Result contains the possible values of the POU operation results.

q_sResultMsg

STRING[80]

Provides additional information about the current status of the POU.

Return Value

Data type

Description

BOOL

The function returns TRUE if the element-wise difference between two 2D input vectors is within the range [-i_lrEps ... i_lrEps], otherwise FALSE.

Diagnostic Messages

q_xError

q_etResult

Enumeration value

Description

FALSE

Ok

0

Success

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success