FC_CartesianToPlanarPolar

FC_CartesianToPlanarPolar - General Information

Overview

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

Task

Convert 2 dimensional Cartesian coordinates into a planar polar coordinates.

Description

The cartesian coordinates are converted to polar coordinates. In doing so, it is assumed that the origin of the cartesian coordinate system corresponds to the pole of the polar coordinate system and that the X axis of the cartesian coordinate system corresponds to the horizontal axis of the polar coordinate system.

Interface

Input	Data type	Description
i_stPoint	ST_Vector2D	Point defined by cartesian coordinates

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
ST_PlanarPolarCoordinates	The point of input i_stPoint in polar coordinates

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The coordinates have been converted successfully.