API Docs

Class: Velocity

PD.Units. Velocity

Provides tools to convert between velocity units.

Use static methods for arbitrary conversions and instance methods when converting to and/or from a specific unit multiple times. The available velocity unit types are: PD.Units.METERS_PER_SECOND, PD.Units.KILOMETERS_PER_HOUR, PD.Units.FEET_PER_SECOND, PD.Units.FEET_PER_MINUTE, PD.Units.MILES_PER_HOUR and PD.Units.KNOTS.

new Velocity( [units])

Creates a velocity converter.

Parameters:
Name Type Argument Description
units number <optional>

The units type identifier, defaults to PD.Units.METERS_PER_SECOND.

Members

:number

units

The numeric identifier defining the type of stored units.

The value of this property should equate to PD.Units.METERS_PER_SECOND, PD.Units.KILOMETERS_PER_HOUR , PD.Units.FEET_PER_SECOND, PD.Units.FEET_PER_MINUTE, PD.Units.MILES_PER_HOUR and PD.Units.KNOTS. Any other value is assumed to be meters per second.

Type
  • number

Methods

fromFeetPerMinute(btu_lb)

Converts from feet per minute to the current units.

Parameters:
Name Type Description
btu_lb number

The value to convert in feet per minute (fpm).
Returns:

Returns the value converted to the current units.

Type
number

fromFeetPerSecond(btu_lb)

Converts from feet per second to the current units.

Parameters:
Name Type Description
btu_lb number

The value to convert in feet per second (ft/s).
Returns:

Returns the value converted to the current units.

Type
number

fromKilometersPerHour(kJ_kg)

Converts from kilometres per hour to the current units.

Parameters:
Name Type Description
kJ_kg number

The value to convert in kilometres per hour (km/h).
Returns:

Returns the value converted to the current units.

Type
number

fromKnots(btu_lb)

Converts from knots to the current units.

Parameters:
Name Type Description
btu_lb number

The value to convert in knots (kn).
Returns:

Returns the value converted to the current units.

Type
number

fromMetersPerSecond(J_kg)

Converts from meters per second to the current units.

Parameters:
Name Type Description
J_kg number

The value to convert in meters per second (m/s).
Returns:

Returns the value converted to the current units.

Type
number

fromMilesPerHour(btu_lb)

Converts from miles per hour to the current units.

Parameters:
Name Type Description
btu_lb number

The value to convert in miles per hour (mph).
Returns:

Returns the value converted to the current units.

Type
number

getAbbrev()

Retrieve the abbreviation of the stored units.

Depending on the current units, this method returns one of the following string values: 'm/s', 'km/h', 'ft/s', 'mph' or 'kn'.

Returns:

Returns the abbreviation of the current units.

Type
string

getName()

Retrieve the full name of the stored units.

Depending on the current units, this method returns one of the following string values: 'Meters per Second', 'Kilometers per Hour', 'Feet per Second', 'Miles per Hour' or 'Knots'.

Returns:

Returns the full name of the current units.

Type
string

getUnitsId()

Retrieves the currently units identifier as a numeric value.

Returns:

Returns the current units identifier.

Type
number

set(units)

Sets the current velocity unit and updates conversions.

Parameters:
Name Type Description
units number

The new units identifier (PD.Units.METERS_PER_SECOND | KILOMETERS_PER_HOUR | FEET_PER_SECOND | FEET_PER_MINUTE | MILES_PER_HOUR | KNOTS).
Returns:

Returns this Velocity object to support method chaining.

Type
object

toFeetPerMinute(value)

Converts the given value to feet per minute (fpm).

Parameters:
Name Type Description
value number

The value to convert, must be in stored units.
Returns:

Returns the value converted to feet per minute (fpm).

Type
number

toFeetPerSecond(value)

Converts the given value to feet per second (ft/s).

Parameters:
Name Type Description
value number

The value to convert, must be in stored units.
Returns:

Returns the value converted to feet per second (ft/s).

Type
number

toKilometersPerHour(value)

Converts the given value to kilometres per hour (km/h).

Parameters:
Name Type Description
value number

The value to convert, must be in stored units.
Returns:

Returns the value converted to kilometres per hour (km/h).

Type
number

toKnots(value)

Converts the given value to knots (kn).

Parameters:
Name Type Description
value number

The value to convert, must be in stored units.
Returns:

Returns the value converted to knots (kn).

Type
number

toMetersPerSecond(value)

Converts the given value to meters per second (m/s).

Parameters:
Name Type Description
value number

The value to convert, must be in stored units.
Returns:

Returns the value converted to meters per second (m/s).

Type
number

toMilesPerHour(value)

Converts the given value to miles per hour (mph).

Parameters:
Name Type Description
value number

The value to convert, must be in stored units.
Returns:

Returns the value converted to miles per hour (mph).

Type
number

convertFeetPerMinuteToFeetPerSecond(ft_min) <static>

Converts a value in feet per minute (fpm) to feet per second (ft/s).

Parameters:
Name Type Description
ft_min number

The value to convert, in feet per minute (fpm).
Returns:

Returns the value converted to feet per second (ft/s).

Type
number

convertFeetPerMinuteToKilometersPerHour(ft_min) <static>

Converts a value in feet per minute (fpm) to kilometres per hour (km/h).

Parameters:
Name Type Description
ft_min number

The value to convert, in feet per minute (fpm).
Returns:

Returns the value converted to kilometres per hour (km/h).

Type
number

convertFeetPerMinuteToKnots(ft_min) <static>

Converts a value in feet per minute (fpm) to knots (kn).

Parameters:
Name Type Description
ft_min number

The value to convert, in feet per minute (fpm).
Returns:

Returns the value converted to knots (kn).

Type
number

convertFeetPerMinuteToMetersPerSecond(ft_min) <static>

Converts a value in feet per minute (fpm) to meters per second (m/s).

Parameters:
Name Type Description
ft_min number

The value to convert, in feet per minute (fpm).
Returns:

Returns the value converted to meters per second (m/s).

Type
number

convertFeetPerMinuteToMilesPerHour(ft_min) <static>

Converts a value in feet per minute (fpm) to miles per hour (mph).

Parameters:
Name Type Description
ft_min number

The value to convert, in feet per minute (fpm).
Returns:

Returns the value converted to miles per hour (mph).

Type
number

convertFeetPerSecondToFeetPerMinute(ft_s) <static>

Converts a value in feet per second (ft/s) to feet per minute (fpm).

Parameters:
Name Type Description
ft_s number

The value to convert, in feet per second (ft/s).
Returns:

Returns the value converted to feet per minute (fpm).

Type
number

convertFeetPerSecondToKilometersPerHour(ft_s) <static>

Converts a value in feet per second (ft/s) to kilometres per hour (km/h).

Parameters:
Name Type Description
ft_s number

The value to convert, in feet per second (ft/s).
Returns:

Returns the value converted to kilometres per hour (km/h).

Type
number

convertFeetPerSecondToKnots(ft_s) <static>

Converts a value in feet per second (ft/s) to knots (kn).

Parameters:
Name Type Description
ft_s number

The value to convert, in feet per second (ft/s).
Returns:

Returns the value converted to knots (kn).

Type
number

convertFeetPerSecondToMetersPerSecond(ft_s) <static>

Converts a value in feet per second (ft/s) to meters per second (m/s).

Parameters:
Name Type Description
ft_s number

The value to convert, in feet per second (ft/s).
Returns:

Returns the value converted to meters per second (m/s).

Type
number

convertFeetPerSecondToMilesPerHour(ft_s) <static>

Converts a value in feet per second (ft/s) to miles per hour (mph).

Parameters:
Name Type Description
ft_s number

The value to convert, in feet per second (ft/s).
Returns:

Returns the value converted to miles per hour (mph).

Type
number

convertKilometersPerHourToFeetPerMinute(km_h) <static>

Converts a value in kilometres per hour (km/h) to feet per minute (fpm).

Parameters:
Name Type Description
km_h number

The value to convert, in kilometres per hour (km/h).
Returns:

Returns the value converted to feet per minute (fpm).

Type
number

convertKilometersPerHourToFeetPerSecond(km_h) <static>

Converts a value in kilometres per hour (km/h) to feet per second (ft/s).

Parameters:
Name Type Description
km_h number

The value to convert, in kilometres per hour (km/h).
Returns:

Returns the value converted to feet per second (ft/s).

Type
number

convertKilometersPerHourToKnots(km_h) <static>

Converts a value in kilometres per hour (km/h) to knots (kn).

Parameters:
Name Type Description
km_h number

The value to convert, in kilometres per hour (km/h).
Returns:

Returns the value converted to knots (kn).

Type
number

convertKilometersPerHourToMetersPerSecond(km_h) <static>

Converts a value in kilometres per hour (km/h) to meters per second (m/s).

Parameters:
Name Type Description
km_h number

The value to convert, in kilometres per hour (km/h).
Returns:

Returns the value converted to meters per second (m/s).

Type
number

convertKilometersPerHourToMilesPerHour(km_h) <static>

Converts a value in kilometres per hour (km/h) to miles per hour (mph).

Parameters:
Name Type Description
km_h number

The value to convert, in kilometres per hour (km/h).
Returns:

Returns the value converted to miles per hour (mph).

Type
number

convertKnotsToFeetPerMinute(kn) <static>

Converts a value in knots (kn) to feet per minute (fpm).

Parameters:
Name Type Description
kn number

The value to convert, in knots (kn).
Returns:

Returns the value converted to feet per minute (fpm).

Type
number

convertKnotsToFeetPerSecond(kn) <static>

Converts a value in knots (kn) to feet per second (ft/s).

Parameters:
Name Type Description
kn number

The value to convert, in knots (kn).
Returns:

Returns the value converted to feet per second (ft/s).

Type
number

convertKnotsToKilometersPerHour(kn) <static>

Converts a value in knots (kn) to kilometres per hour (km/h).

Parameters:
Name Type Description
kn number

The value to convert, in knots (kn).
Returns:

Returns the value converted to kilometres per hour (km/h).

Type
number

convertKnotsToMetersPerSecond(kn) <static>

Converts a value in knots (kn) to meters per second (m/s).

Parameters:
Name Type Description
kn number

The value to convert, in knots (kn).
Returns:

Returns the value converted to meters per second (m/s).

Type
number

convertKnotsToMilesPerHour(kn) <static>

Converts a value in knots (kn) to miles per hour (mph).

Parameters:
Name Type Description
kn number

The value to convert, in knots (kn).
Returns:

Returns the value converted to miles per hour (mph).

Type
number

convertMetersPerSecondToFeetPerMinute(m_s) <static>

Converts a value in meters per second (m/s) to feet per minute (fpm).

Parameters:
Name Type Description
m_s number

The value to convert, in meters per second (m/s).
Returns:

Returns the value converted to feet per minute (fpm).

Type
number

convertMetersPerSecondToFeetPerSecond(m_s) <static>

Converts a value in meters per second (m/s) to feet per second (ft/s).

Parameters:
Name Type Description
m_s number

The value to convert, in meters per second (m/s).
Returns:

Returns the value converted to feet per second (ft/s).

Type
number

convertMetersPerSecondToKilometersPerHour(m_s) <static>

Converts a value in meters per second (m/s) to kilometres per hour (km/h).

Parameters:
Name Type Description
m_s number

The value to convert, in meters per second (m/s).
Returns:

Returns the value converted to kilometres per hour (km/h).

Type
number

convertMetersPerSecondToKnots(m_s) <static>

Converts a value in meters per second (m/s) to knots (kn).

Parameters:
Name Type Description
m_s number

The value to convert, in meters per second (m/s).
Returns:

Returns the value converted to knots (kn).

Type
number

convertMetersPerSecondToMilesPerHour(m_s) <static>

Converts a value in meters per second (m/s) to miles per hour (mph).

Parameters:
Name Type Description
m_s number

The value to convert, in meters per second (m/s).
Returns:

Returns the value converted to miles per hour (mph).

Type
number

convertMilesPerHourToFeetPerMinute(mph) <static>

Converts a value in miles per hour (mph) to feet per minute (fpm).

Parameters:
Name Type Description
mph number

The value to convert, in miles per hour (mph).
Returns:

Returns the value converted to feet minute (fpm).

Type
number

convertMilesPerHourToFeetPerSecond(mph) <static>

Converts a value in miles per hour (mph) to feet per second (ft/s).

Parameters:
Name Type Description
mph number

The value to convert, in miles per hour (mph).
Returns:

Returns the value converted to feet per second (ft/s).

Type
number

convertMilesPerHourToKilometersPerHour(mph) <static>

Converts a value in miles per hour (mph) to kilometres per hour (km/h).

Parameters:
Name Type Description
mph number

The value to convert, in miles per hour (mph).
Returns:

Returns the value converted to kilometres per hour (km/h).

Type
number

convertMilesPerHourToKnots(mph) <static>

Converts a value in miles per hour (mph) to knots (kn).

Parameters:
Name Type Description
mph number

The value to convert, in miles per hour (mph).
Returns:

Returns the value converted to knots (kn).

Type
number

convertMilesPerHourToMetersPerSecond(mph) <static>

Converts a value in miles per hour (mph) to meters per second (m/s).

Parameters:
Name Type Description
mph number

The value to convert, in miles per hour (mph).
Returns:

Returns the value converted to meters per second (m/s).

Type
number

getAbbrev(units) <static>

Retrieves the abbreviation of the given velocity units.

Based on the given units, this method returns one of the following string values: 'm/s', 'km/h', 'ft/s', 'mph' or 'kn'.

Parameters:
Name Type Description
units number

The numeric units identifier (PD.Units.METERS_PER_SECOND | KILOMETERS_PER_HOUR | FEET_PER_SECOND | FEET_PER_MINUTE | MILES_PER_HOUR | KNOTS).
Returns:

Returns the abbreviation of the given velocity units.

Type
string

getName(units) <static>

Retrieves the name of the given velocity units.

Based on the given units, this method returns one of the following string values: 'Meters per Second', 'Kilometers per Hour', 'Feet per Second', 'Miles per Hour' or 'Knots'.

Parameters:
Name Type Description
units number

The numeric units identifier (PD.Units.METERS_PER_SECOND | KILOMETERS_PER_HOUR | FEET_PER_SECOND | FEET_PER_MINUTE | MILES_PER_HOUR | KNOTS).
Returns:

Returns the name of the given velocity units.

Type
string

getUnitsFromAbbrev(abbrev) <static>

Retrieves the v units identifier from the given abbreviation.

Interprets the abbreviations 'm/s', 'km/h', 'ft/s', 'mph' or 'kn' into the identifiers PD.Units.METERS_PER_SECOND | KILOMETERS_PER_HOUR | FEET_PER_SECOND | FEET_PER_MINUTE | MILES_PER_HOUR | KNOTS.

Parameters:
Name Type Description
abbrev string

The abbreviation of the given velocity units.
Returns:

Returns the The numeric units identifier.

Type
number