new Unit()
Represents a baja:Unit
in BajaScript.
When creating a Simple
, always use the make()
method instead of
creating a new Object.
Extends
Members
-
<static> DEFAULT :baja.Unit
-
Default
Unit
instance.Type:
-
<static> NULL :baja.Unit
-
Null
Unit
instance (same asDEFAULT
).Type:
-
isPrefix
-
Returns true if the unit should be prefixed.
Methods
-
<static> make(name [, symbol], dimension [, scale] [, offset] [, isPrefix])
-
Creates a new instance of
baja.Unit
.Note that if calling this function directly, multiple calls with the same
name but different dimensions will result in an error (no messing with
the laws of physics!). Be careful not to manually createUnit
s with
incorrect dimensions that might clash with units specified in the unit
database stationside.Parameters:
Name Type Argument Default Description name
String the unit name. Must be unique and may not contain a
semicolon.symbol
String <optional>
name the unit symbol. If omitted will default to
the unit name. May not contain a semicolon.dimension
baja.Dimension the unit dimension
scale
Number <optional>
1 the unit scale
offset
Number <optional>
0 the unit offset
isPrefix
Boolean <optional>
false true if the unit should be prefixed /
displayed on the left of the actual valueThrows:
if name or symbol contain a semicolon, the dimension is omitted,
or if duplicate units are created with the same name but different
dimensionsReturns:
- Type
- baja.Unit
-
convertTo(toUnit, scalar)
-
Convert a scalar value from this unit to another.
Parameters:
Name Type Description toUnit
baja.Unit scalar
number Throws:
-
if the two Units are not of the same Dimension
- Type
- Error
Returns:
the converted scalar value
- Type
- number
-
-
decodeAsync(str [, batch])
-
The string encoding of certain Simples may include Type information, or
other data that may be require asynchronous operations to decode. BOX is
designed to handle these situations when decoding data from the station,
but when user code needs to decode string-encoded Simples directly, prefer
this method as it gives the individual Simple a chance to import Types,
etc. to ensure that the decoded Simple is fully correct.The default implementation just returns
decodeFromString
directly.Parameters:
Name Type Argument Description str
string batch
baja.comm.Batch <optional>
optional batch to use
- Inherited From:
Returns:
may return the Simple instance
directly, or a Promise resolving to same - so wrap inPromise.resolve()
if unsure.- Type
- baja.Simple | Promise.<baja.Simple>
-
decodeFromString(str)
-
Parse a
baja.Unit
from aString
.Parameters:
Name Type Description str
String - Overrides:
Throws:
if string is malformed or contains invalid unit parameters
Returns:
- Type
- baja.Unit
-
encodeToString()
-
Encode a
baja.Unit
to aString
.- Overrides:
Returns:
- Type
- String
-
equals(obj)
-
Equality test.
Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
equivalent(obj)
-
Equivalence test.
equivalent()
is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
getAgents( [is], batch)
-
Returns a promise that resolves to the agent list for this Object.
Parameters:
Name Type Argument Description is
Array.<String> <optional>
An optional array of filters to add to the
agent query.batch
baja.comm.Batch An optional object used to batch network
calls together.- Inherited From:
- See:
Returns:
A promise that will resolve with the Agent Info.
- Type
- Promise
-
getDataTypeSymbol()
-
Returns the data type symbol (
u
) forFacets
encoding.Returns:
- Type
- String
-
getDimension()
-
Returns the unit dimension.
Returns:
- Type
- baja.Dimension
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getOffset()
-
Returns the unit offset.
Returns:
- Type
- Number
-
getScale()
-
Returns the unit scale.
Returns:
- Type
- Number
-
getSymbol()
-
Returns the unit symbol.
Returns:
- Type
- String
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
getUnitName()
-
Returns the unit name.
Returns:
- Type
- String
-
make()
-
- Overrides:
- See:
Returns:
- Type
- baja.Unit
-
newCopy( [exact])
-
Every value may be cloned using the
newCopy
method.Please note that
Simple
s are immutable so they don't
allocate a new instance.Parameters:
Name Type Argument Description exact
Boolean <optional>
true if an exact copy of the value should be
made (only valid in the Component architecture).- Inherited From:
- See:
Returns:
a copy of the value (or the same instance if the value is a
Simple
). -
toString()
-
Returns the unit symbol.
- Overrides:
Returns:
- Type
- String
-
valueOf()
-
Return the inner value of the object.
By default the object's instance is returned.
- Inherited From:
Returns:
the inner value of the object or just the object's instance.
- Type
- *