FC_Vector2DDotProduct - 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 their dot product; the result is a scalar value.

Interface

Input

Data type

Description

i_stVectorA

SE_MATH.ST_Vector2D

A 2D vector.

i_stVectorB

SE_MATH.ST_Vector2D

A 2D vector.

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

LREAL

The function returns the dot product between two input 2D vectors. The result is a scalar value.

Diagnostic Messages

q_xError

q_etResult

Enumeration value

Description

FALSE

Ok

0

Success

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success