PLGetZeroGapGuideReaction

<< Click to Display Table of Contents >>

Navigation:  PipeLay > Excel Add-In > Function Reference > Force Functions >

PLGetZeroGapGuideReaction

Previous page Next page

PURPOSE

Retrieve a Zero Gap Guide Reaction value from the database.

NOTE: You can also use PLGetValue with parameter number 14 to retrieve the same data.

SYNTAX

PLGetZeroGapGuideReaction( DatabaseName, TimeIndex, ZGGIndex, DOFNo )

NOTE: You can also use PLGetValue with parameter number 14 to retrieve the same data.

PARAMETERS

DatabaseName (Character String)

The full path and filename to the relevant database. The file extension is optional.

TimeIndex (Integer)

The relevant time index, from 1 to the number of solutions in the database.

ZGGIndex (Integer)

The index of the zero gap guide from 1 to number of zero gap guides.

DOFNo (Integer)

The Degree of Freedom in the range of 1 to 3.

OUTPUT

A numerical value containing the Zero Gap Guide Reaction value for the specified parameters or one of the following error codes:

-999999998

Invalid Database.

-999999995

Invalid Time Index.

-999999990

No Data Available.

-999999988

Item Index is out of range.

-999999985

Degree of Freedom/Local Node Number is out of range.

-999999980

General Read Error.

UNITS

Imperial

Metric

lbf

N

SEE ALSO

Error Codes

PLGetNumSolutionTimes

PLGetContactSurfaceCount

PLGetValue

PLGetAxialForce

PLGetContactSurfaceReaction

PLGetEffectiveTension

PLGetLocalAxialStrain

PLGetLocalAxialStrainFromForceOnly

PLGetLocalShearYForce

PLGetLocalShearYForce

PLGetLocalYBendingMoment

PLGetLocalYCurvature

PLGetLocalZBendingMoment

PLGetLocalZCurvature

PLGetPipeInPipeReaction

PLGetReactions

PLGetTorque

Back to Table of Contents