PLGetVelocity

<< Click to Display Table of Contents >>

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

PLGetVelocity

Previous page Next page

PURPOSE

Retrieve a Velocity value from the database.

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

SYNTAX

PLGetVelocity( DatabaseName, TimeIndex, NodeIndex, DOFNo )

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 velocity 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/s

m/s

4-7

deg/s

deg/s

SEE ALSO

Error Codes

PLGetNodeCount

PLGetNumSolutionTimes

PLGetAcceleration

PLGetPosition

PLGetValue

Back to Table of Contents