bajaScript

Class: Enum

baja. Enum

new Enum()

Represents a baja:Enum in BajaScript.

Extends

Methods

<static> getEnumFromIEnum(enumVal)

Return an Enum from a BIEnum.

Parameters:
Name Type Description
enumVal baja.Complex | Object

a baja:StatusEnum, a baja.Complex with a baja:StatusEnum out slot, or any object with a getEnum function defined.
Throws:

if a non-baja.Value was passed in

Type
Error
Returns:

the derived Enum value, or baja.DynamicEnum.DEFAULT if none present.

Type
baja.Enum

<static> getFacetsFromIEnum(enumVal)

Return facets from an IEnum

Parameters:
Name Type Description
enumVal baja.Value
Returns:
Type
baja.Facets

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>

<abstract> decodeFromString(str)

Every Simple implementation must have a decodeFromString function.

Parameters:
Name Type Description
str string
Inherited From:
Returns:
Type
baja.Simple

<abstract> encodeToString()

Every Simple implementation must have an encodeToString function.

Inherited From:
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

getEnum()

Return the Enum (itself).

Returns:
Type
baja.Enum

getIcon()

Return the Object's Icon.

Inherited From:
Returns:
Type
baja.Icon

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

<abstract> make()

Every Simple implementation must have a make function. It can take
any arbitrary arguments. When constructing the Simple with baja.$, any
additional arguments will be passed to make(), with the following special
cases:

  • When no arguments are passed, baja.$ will return the DEFAULT
    instance.
  • When one argument is passed and it is a string, baja.$ will use
    decodeFromString() to create the instance.
Inherited From:
Returns:
Type
baja.Simple
Example
//in the Simple declaration:
MySimple.prototype.make = function (a, b, c) {
  var mySimple = new MySimple();
  mySimple.a = a;
  mySimple.b = b;
  mySimple.c = c;
  return mySimple;
};

//when constructing:
var mySimple = baja.$('myModule:MySimple', 'a', 'b', 'c');

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

Return the ordinal of the Enum (itself).

Overrides:
Returns:
Type
Number