bajaScript

Class: EnumSet

baja. EnumSet

new EnumSet()

Represents a baja:EnumSet in BajaScript.

An EnumSet contains an EnumRange and an array of ordinals.

When creating a Simple, always use the make() method instead of
creating a new Object.

Extends

Members

<static> DEFAULT :baja.EnumSet

Default EnumSet instance.

Type:

<static> NULL :baja.EnumSet

NULL EnumSet instance.

Type:

Methods

<static> make(obj)

Make an EnumSet. An EnumSet can be created using either an array of
ordinals (in which case the range will be set to
baja.EnumRange.DEFAULT), or, to specify a range as well, an
object literal with ordinals and range properties.

Parameters:
Name Type Description
obj Object | Array.<Number>

the object literal that holds the
method's arguments (or an array of ordinals).

Properties
Name Type Argument Description
ordinals Array.<Number> <optional>

an array of ordinals.
range baja.EnumRange <optional>

the EnumRange to assign the EnumSet.
Returns:

the EnumSet.

Type
baja.EnumSet
Example
var defaultRange = baja.EnumSet.make([0, 1, 2]);
  var customRange = baja.EnumSet.make({
    ordinals: [0, 2, 4],
    range: baja.EnumRange.make({
      ordinals: [0, 1, 2, 3, 4],
      tags: ['a', 'b', 'c', 'd', 'e']
    })
  });

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 in Promise.resolve()
if unsure.

Type
baja.Simple | Promise.<baja.Simple>

decodeFromString(str)

Decode an EnumSet from a String.

Parameters:
Name Type Description
str String
Overrides:
Returns:
Type
baja.EnumSet

encodeToString()

Encode an EnumSet to a String.

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 <optional>

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()

Return the data type symbol (E).

Returns:

data type symbol

Type
String

getIcon()

Return the Object's Icon.

Inherited From:
Returns:
Type
baja.Icon

getOrdinals()

Return all of the ordinals for the EnumSet.

Returns:

an array of numbers that represents the ordinals for this EnumSet.

Type
Array

getRange()

Return the range.

Returns:
Type
baja.EnumRange

getType()

Get the type of this instance.

Inherited From:
Returns:
Type
Type

getTypeDisplayName( [cx])

Gets the friendly type display name for this object.

Parameters:
Name Type Argument Description
cx Object <optional>

a context to be passed down to Type
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Returns:

If no context is provided, the type
display name is returned synchronously as a string. If context provided,
the type display name is resolved via a promise as a string.

Type
Promise.<string> | string

make()

Make an EnumSet. Same as static method baja.EnumSet.make.

Overrides:
See:

newCopy( [exact])

Every value may be cloned using the newCopy method.

Please note that Simples 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( [cx])

Returns the String representation of this object.

Parameters:
Name Type Argument Description
cx Object <optional>

optional context information to be used when
formatting the string
Inherited From:
See:
Returns:

a string (if no context passed), or
either a string or a Promise (if context passed).

Type
String | Promise.<String>

valueOf()

Inherited From:
Returns:

the string encoding of the Simple, by default

Type
String