SolarNetwork Core

Class: LocationPrecision

domain~ LocationPrecision

A location precision object for use with defining named geographic precision.

new LocationPrecision(name, precision)

Constructor.

Extends:
Parameters:
Name Type Description
name string

the unique name for this precision
precision number

a relative precision value for this precision

Extends

Members

name

Get the enum name.

Inherited From:
Overrides:

precision

Get the relative precision value.

This is an alias for #name.

value

Get the comparable value.

Inherited From:
Overrides:

Methods

<static> enumValues()

Get the module:domain~LocationPrecisions values.

compareTo(other)

Compare two ComparableEnum objects based on their value values.

Parameters:
Name Type Description
other ComparableEnum

the object to compare to
Inherited From:
Overrides:
Returns:

-1 if this.value is less than other.value, 1 if this.value is greater than other.value, 0 otherwise (when the values are equal)

Type
number

equals(value)

Test if a string is equal to this enum's name.

As long as enum values are consistently obtained from the module:util~Enum.enumValues array then enum instances can be compared with ===. If unsure, this method can be used to compare string values instead.

If value is passed as an actual Enum instance, then if that enum is the same class as this enum it's name is compared to this instance's name.

Parameters:
Name Type Description
value string | Enum

the value to test
Inherited From:
Overrides:
Returns:

true if value is the same as this instance's name value

Type
boolean