OrdList

baja. OrdList

new OrdList()

Description:

  • A list of Ords.

    This constructor shouldn't be invoked directly. Please use the make()
    function to create an instance of an OrdList.

Source:
See:

Extends

Members

decodeFromString

Description:

  • Decode an OrdList from a String.

Source:
Overrides:

Decode an OrdList from a String.

encodeToString

Description:

  • Encode an OrdList to a String.

Source:
Overrides:

Encode an OrdList to a String.

(static) DEFAULT :baja.OrdList

Description:

  • Default OrdList instance.

Source:

Default OrdList instance.

Type:

Methods

decodeAsync(str, batchopt) → {baja.Simple|Promise.<baja.Simple>}

Description:

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

Source:
Inherited From:
Parameters:
Name Type Attributes Description
str string
batch baja.comm.Batch <optional>

optional batch to use
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>

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

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getOrds() → {Array}

Description:

  • Get the full list of Ords.

Source:
Returns:
Type
Array

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(ords) → {baja.OrdList}

Description:

  • Make a new instance of an OrdList.

Source:
Overrides:
See:
Parameters:
Name Type Description
ords Array.<(String|baja.Ord)>
Returns:
Type
baja.OrdList

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

size() → {Number}

Description:

  • Get the number of Ords in the OrdList.

Source:
Returns:
Type
Number

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(ords) → {baja.OrdList}

Description:

  • Make a new instance of an OrdList.

    The argument must be an Array that only contains Strings and Ords.

Source:
Parameters:
Name Type Description
ords Array.<(String|baja.Ord)>
Returns:
Type
baja.OrdList