PLGetPosition

<< Click to Display Table of Contents >>

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

PLGetPosition

Previous page Next page

PURPOSE

Retrieve a Position/Motion value from the database.

SYNTAX

PLGetPosition( DatabaseName, TimeIndex, NodeIndex, DOFNo )

NOTE: You can also use PLGetValue with parameter number 16 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.

NodeIndex (Integer)

The index of the node to retrieve the data for

DOFNo (Integer)

The Degree Of Freedom (1-7)

OUTPUT

A numerical value containing the position for the specified time, node and degree of freedom or one of the following error codes:

-999999998

Invalid Database.

-999999995

Invalid Time Index

-999999990

No Data Available.

-999999987

Node Index is out of range

-999999984

Specified Degree of Freedom is not between 1 and 7

-999999980

General Read Error

UNITS

DOF

Imperial

Metric

1-3

ft

m

4-7

deg

deg

SEE ALSO

Error Codes

PLGetNodeCount

PLGetNumSolutionTimes

PLGetAcceleration

PLGetValue

PLGetVelocity

 

Back to Table of Contents