FC_CommonPointsOfSphereAndCircle

 

FC_CommonPointsOfSphereAndCircle - General Information

Overview

Type:

Function

Available as of:

V1.0.3.0

Versions:

Current version

Task

Calculates the intersections of a circle and a sphere in the 3-dimensional space.

Description

Calculates the intersections of the sphere i_stSphere and the circle i_stCircle. If there are no intersections, the q_diNumberOfCommonPoints is 0.

Interface

Input

Data type

Description

i_stSphere

ST_Sphere

Sphere

i_stCircle

ST_Circle3D

circle

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

q_diNumberOfCommonPoints

DINT

Number of intersections

astCommonPoints

ARRAY [1..2] OF ST_Vector3D

Array which contains the intersections of i_stSphere and i_stCircle (only the first q_diNumberOfCommonPoints entries are valid).

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Ok

InputParameterInvalid

RadiusRangeCircle

26

The radius of the circle is outside the valid range.

InputParameterInvalid

RadiusRangeSphere

22

The radius of the sphere is outside the valid range.

UnexpectedProgramBehavior

UnexpectedFeedback

1

An unintended detected error occurred during execution.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

The intersections have been calculated successfully.

RadiusRangeCircle

Enumeration name:

RadiusRangeCircle

Enumeration value:

26

Description:

The radius of the circle is outside the valid range.

Issue

Cause

Solution

-

At the input i_stCircle.lrRadius, a number <= 0 has been transferred.

The radius of the circle must be greater than zero.

RadiusRangeSphere

Enumeration name:

RadiusRangeSphere

Enumeration value:

22

Description:

The radius of the sphere is outside the valid range.

Issue

Cause

Solution

-

At the input i_stSphere.lrRadius, a number <= 0 has been applied.

The radius of the sphere must be greater than 0.

UnexpectedFeedback

Enumeration name:

UnexpectedFeedback

Enumeration value:

1

Description:

An unintended detected error occurred during execution.

Issue

Cause

Solution

-

An error occurred in the internal execution.

Please inform the support team about this error.