EnumSet

baja. EnumSet

new EnumSet()

Description:

  • 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.

Source:

Extends

Members

(static) DEFAULT :baja.EnumSet

Description:

  • Default EnumSet instance.

Source:

Default EnumSet instance.

Type:

(static) NULL :baja.EnumSet

Description:

  • NULL EnumSet instance.

Source:

NULL EnumSet instance.

Type:

Methods

decodeAsync(str) → {Promise.<baja.EnumSet>}

Source:
Overrides:
Parameters:
Name Type Description
str string
Returns:
Type
Promise.<baja.EnumSet>

decodeFromString(str, paramsopt) → {baja.EnumSet}

Description:

  • Decode an EnumSet from a String.

Source:
Overrides:
Parameters:
Name Type Attributes Description
str String
params Object <optional>
Properties
Name Type Attributes Default Description
unsafe Boolean <optional>
 false

if set to true, this will allow
decodeFromString to continue. If not, decodeFromString will throw an error. This flag is for
internal bajaScript use only. All external implementations should use decodeAsync instead.
Returns:
Type
baja.EnumSet

encodeToString() → {String}

Description:

  • Encode an EnumSet to a String.

Source:
Overrides:
Returns:
Type
String

equals(obj) → {Boolean}

Description:

  • Equality test.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

equivalent(obj) → {Boolean}

Description:

  • 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.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

getAgents(isopt, batchopt) → {Promise}

Description:

  • Returns a promise that resolves to the agent list for this Object.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes 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.
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getDataTypeSymbol() → {String}

Description:

  • Return the data type symbol (E).

Source:
Returns:

data type symbol

Type
String

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getOrdinals() → {Array}

Description:

  • Return all of the ordinals for the EnumSet.

Source:
Returns:

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

Type
Array

getRange() → {baja.EnumRange}

Description:

  • Return the range.

Source:
Returns:
Type
baja.EnumRange

getType() → {Type}

Description:

  • Get the type of this instance.

Source:
Inherited From:
Returns:
Type
Type

getTypeDisplayName(cxopt) → {Promise.<string>|string}

Description:

  • Gets the friendly type display name for this object.

Source:
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Parameters:
Name Type Attributes Description
cx Object <optional>

a context to be passed down to Type
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()

Description:
Source:
Overrides:
See:

newCopy(exactopt)

Description:

  • Every value may be cloned using the newCopy method.

    Please note that Simples are immutable so they don't
    allocate a new instance.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
exact Boolean <optional>

true if an exact copy of the value should be
made (only valid in the Component architecture).
Returns:

a copy of the value (or the same instance if the value is a
Simple).

toString(cxopt) → {String|Promise.<String>}

Description:

  • Returns the String representation of this object.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
cx Object <optional>

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

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

Type
String | Promise.<String>

valueOf() → {String}

Source:
Inherited From:
Returns:

the string encoding of the Simple, by default

Type
String

(static) make(obj) → {baja.EnumSet}

Description:

  • 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.

Source:
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']
    })
  });
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 Attributes 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