new Dimension()
Represents a baja:Dimension
in BajaScript.
When creating a Simple
, always use the make()
method instead of
creating a new Object.
Extends
Members
-
<static> DEFAULT :baja.Dimension
-
Default
Dimension
instance.Type:
-
<static> NULL :baja.Dimension
-
Null
Dimension
instance (same asDEFAULT
).Type:
Methods
-
<static> make(meter, kilogram, second, ampere, kelvin, mole, candela, dollar)
-
Create a new instance of
baja.Dimension
. Each parameter will be an
exponent for a particular unit of measurement. 0 indicates the absence of
that unit, 1 indicates linear, 2 for squared, 3 for cubed, etc.Parameters:
Name Type Default Description meter
Number 0 exponent for the meter component
kilogram
Number 0 exponent for the kilogram component
second
Number 0 exponent for the second component
ampere
Number 0 exponent for the ampere component
kelvin
Number 0 exponent for the Kelvin component
mole
Number 0 exponent for the mole component
candela
Number 0 exponent for the candela component
dollar
Number 0 exponent for the dollar component
Returns:
- Type
- baja.Dimension
-
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)
-
Decode a
Dimension
from aString
.Parameters:
Name Type Description str
String - Overrides:
Returns:
- Type
- baja.Dimension
-
encodeToString()
-
Encode a
Dimension
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
-
getAmpere()
-
Get the ampere component of this dimension.
Returns:
- Type
- Number
-
getCandela()
-
Get the candela component of this dimension.
Returns:
- Type
- Number
-
getDollar()
-
Get the dollar component of this dimension.
Returns:
- Type
- Number
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getKelvin()
-
Get the Kelvin component of this dimension.
Returns:
- Type
- Number
-
getKilogram()
-
Get the kilogram component of this dimension.
Returns:
- Type
- Number
-
getMeter()
-
Get the meter component of this dimension.
Returns:
- Type
- Number
-
getMole()
-
Get the mole component of this dimension.
Returns:
- Type
- Number
-
getSecond()
-
Get the second component of this dimension.
Returns:
- Type
- Number
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
make()
-
- Overrides:
- See:
Returns:
- Type
- baja.Dimension
-
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 a human-readable representation of the dimension.
- 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
- *