PLGetSupportReaction

<< Click to Display Table of Contents >>

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

PLGetSupportReaction

Previous page Next page

PURPOSE

Calculates a Support Reaction based on the guide name.

SYNTAX

PLGetSupportReaction( DatabaseName, GuideName, TimeIndex, DOFNo )

PARAMETERS

DatabaseName (Character String)

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

GuideName (Character String)

The name of the guide.

TimeIndex (Integer)

The time index from 1 to number of solution times

DOFNo (Integer)

The degree of freedom from 1 to 3

OUTPUT

A numerical value containing the support reaction or one of the following error codes:

-999999999

General error (such as no guide surfaces defined).

-999999998

Invalid Database.

-999999995

Invalid Time Index.

-999999993

Invalid Guide Name.

-999999990

No Data Available.

-999999988

Item Index is out of range.

-999999985

The Degree of Freedom or Local Node is not valid.

-999999982

The Guide Index (derived from the name) is not valid.

-999999980

General Read Error.

UNITS

Imperial

Metric

lbf

N

SEE ALSO

Error Codes

PLGetGuideCount

PLGetNumSolutionTimes

PLGetSupportReactionByIndex

PLGetSupportSeparations

PLGetSupportSeparationsByIndex

Back to Table of Contents