FC_Atan2 - General Information

Overview

Type:

Function

Available as of:

V1.0.0.0

Versions:

Current version

This chapter provides information on:

Description

Four quadrant inverse tangent.

Given:

The function returns a value θ in the range [-π, +π] that is evaluated as:

The function is not defined for a zero value of both x and y.

Interface

Input

Data type

Description

i_lrY

LREAL

Numerator of the argument of the arctangent function.

i_lrX

LREAL

Denominator of the argument of the arctangent function.

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 an inverse tangent valueθ in the range [-π, +π].

Diagnostic Messages

q_xError

q_etResult

Enumeration value

Description

FALSE

Ok

0

Success

TRUE

NullInputs

1

All inputs are zero.

NullInputs

Enumeration name:

NullInputs

Enumeration value:

1

Description:

All inputs are zero.

Issue

Cause

Solution

Unable to evaluate the arctangent.

The values i_lrX and i_lrY are zero.

Make sure that at least one of the inputs is not zero.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success