Status

baja. Status

new Status()

Description:

  • Represents a baja:Status in BajaScript.

    Status provides a bit mask for various standardized
    status flags in the Baja control architecture. Plus
    it provides for arbitrary extensions using BFacets.

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

Source:

Extends

Members

(static) ACTIVE_LEVEL :String

Description:

  • String used in a Facets for identifying the active priority level of a
    writable point.

Source:

String used in a Facets for identifying the active priority level of a
writable point.

Type:

(static) ALARM :Number

Description:

  • Bit for alarm.

Source:

Bit for alarm.

Type:
  • Number

(static) DEFAULT :baja.Status

Description:

  • Default Status instance.

Source:

Default Status instance.

Type:

(static) DISABLED :Number

Description:

  • Bit for disabled.

Source:

Bit for disabled.

Type:
  • Number

(static) DOWN :Number

Description:

  • Bit for down.

Source:

Bit for down.

Type:
  • Number

(static) FAULT :Number

Description:

  • Bit for fault.

Source:

Bit for fault.

Type:
  • Number

(static) NULL :Number

Description:

  • Bit for null.

Source:

Bit for null.

Type:
  • Number

(static) OVERRIDDEN :Number

Description:

  • Bit for overridden.

Source:

Bit for overridden.

Type:
  • Number

(static) STALE :Number

Description:

  • Bit for stale.

Source:

Bit for stale.

Type:
  • Number

(static) UNACKED_ALARM :Number

Description:

  • Bit for unacked alarm.

Source:

Bit for unacked alarm.

Type:
  • Number

(static) alarm :baja.Status

Description:

  • Status for alarm (null facets).

Source:

Status for alarm (null facets).

Type:

(static) disabled :baja.Status

Description:

  • Status for disabled (null facets).

Source:

Status for disabled (null facets).

Type:

(static) down :baja.Status

Description:

  • Status for down (null facets).

Source:

Status for down (null facets).

Type:

(static) fault :baja.Status

Description:

  • Status for fault (null facets).

Source:

Status for fault (null facets).

Type:

(static) nullStatus :baja.Status

Description:

  • Status for null status (null facets).

Source:

Status for null status (null facets).

Type:

(static) ok :baja.Status

Description:

  • Status for ok (null facets).

Source:

Status for ok (null facets).

Type:

(static) overridden :baja.Status

Description:

  • Status for overridden (null facets).

Source:

Status for overridden (null facets).

Type:

(static) stale :baja.Status

Description:

  • Status for stale (null facets).

Source:

Status for stale (null facets).

Type:

(static) unackedAlarm :baja.Status

Description:

  • Status for unacked alarm (null facets).

Source:

Status for unacked alarm (null facets).

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>

decodeFromString(str) → {baja.Status}

Description:

  • Decode a Status from a String.

Source:
Overrides:
Parameters:
Name Type Description
str String
Returns:
Type
baja.Status

encodeToString() → {String}

Description:

  • Encode the Status to a String.

Source:
Overrides:
Returns:
Type
String

equals(obj) → {Boolean}

Description:

  • Equality test.

Source:
Overrides:
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

flagsToString() → {String}

Description:

  • Returns a string of just the flags which are set or
    returns ok if none are set.

Source:
Returns:
Type
String

get(name, defopt)

Description:

  • Return a value from the status facets.

Source:
Parameters:
Name Type Attributes Description
name String

the name of the value to get from the status facets.
def <optional>

if defined, this value is returned if the name can't be found in
the status facets.
Returns:

the value from the status facets (null if def is undefined and name can't be found).

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

getBit(ordinal) → {boolean}

Source:
Since:
  • Niagara 4.8
Parameters:
Name Type Description
ordinal number
Returns:

true if this ordinal is set

Type
boolean

getBits() → {Number}

Description:

  • Return the Status bits.

Source:
Returns:

status bits.

Type
Number

getFacets() → {baja.Facets}

Description:

  • Return the facets for the Status.

Source:
Returns:

status facets

Type
baja.Facets

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getOrdinals() → {Array.<number>}

Source:
Since:
  • Niagara 4.8
Returns:

all known Status ordinals

Type
Array.<number>

getStatus() → {baja.Status}

Description:

  • Return the status (itself).

Source:
Returns:

the status (itself).

Type
baja.Status

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

isAlarm() → {Boolean}

Description:

  • Return true if the Status is in alarm.

Source:
Returns:
Type
Boolean

isDisabled() → {Boolean}

Description:

  • Return true if the Status is disabled.

Source:
Returns:
Type
Boolean

isDown() → {Boolean}

Description:

  • Return true if the Status is down.

Source:
Returns:
Type
Boolean

isFault() → {Boolean}

Description:

  • Return true if the Status is in fault.

Source:
Returns:
Type
Boolean

isNull() → {Boolean}

Description:

  • Return true if the Status is null.

Source:
Returns:
Type
Boolean

isOk() → {Boolean}

Description:

  • Return true if the Status is ok.

Source:
Returns:
Type
Boolean

isOverridden() → {Boolean}

Description:

  • Return true if the Status is overridden.

Source:
Returns:
Type
Boolean

isStale() → {Boolean}

Description:

  • Return true if the Status is stale.

Source:
Returns:
Type
Boolean

isUnackedAlarm() → {Boolean}

Description:

  • Return true if the Status is unacked alarm.

Source:
Returns:
Type
Boolean

isValid() → {Boolean}

Description:

  • Return true if the Status is not disabled, fault, down
    stale or null.

Source:
Returns:

true if valid.

Type
Boolean

make(obj) → {baja.Status}

Description:

  • Make a Status.

Source:
Overrides:
Example
//The bits (Number) or (for more arguments) an Object Literal can be 
  //used to specify the method's arguments.

  var st1 = baja.Status.make(baja.Status.DOWN | baja.Status.FAULT);
  
  // ... or for more arguments...
  
  var st2 = baja.$("baja:Status").make({
    bits: baja.Status.DOWN,
    facets: facets
  });
  
  //The make method can also be used to create a new status with its 
  //state changed...
  
  var newStatus = baja.$("baja:Status").make({
    orig: oldStatus, 
    bits: baja.Status.OVERRIDDEN, 
    state: true
  }};
Parameters:
Name Type Description
obj Object | Number

the Object Literal that specifies the method's arguments or Status bits.

Properties
Name Type Attributes Description
bits Number

the Status bits.
facets baja.Facets <optional>

the facets for the Status.
orig baja.Status <optional>

if defined, obj.state must also be defined. This is used to create
a new Status with one of it's bit states changed (see example above).
state Boolean <optional>

the state of the bit to change (used in conjunction with obj.orig).
Returns:

the status.

Type
baja.Status

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

toEnumSet() → {baja.EnumSet}

Source:
Since:
  • Niagara 4.8
Returns:

an EnumSet representing which bits are selected
out of the available bits for a Status

Type
baja.EnumSet

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

Description:

  • Returns the string representation of the 'Status'.

    This method is invoked synchronously. The string result will be returned
    directly from this function.

    Notes on lexicons:

    • A lexicon will be used if it is passed in.
    • If no lexicon is passed in, the baja lexicon will be used if it has been
      cached locally.
    • If the baja lexicon has not been cached, strings units will be
      represented by their internal tag names (which are in English).
Source:
Overrides:
Parameters:
Name Type Description
obj Object

the Object Literal for the method's arguments.

Properties
Name Type Attributes Description
lex <optional>

the 'baja' lexicon
Returns:
Type
String | Promise.<String>

valueOf() → {String}

Source:
Inherited From:
Returns:

the string encoding of the Simple, by default

Type
String

(static) getStatusFromIStatus() → {baja.Status}

Description:

  • Return the status from a BIStatus.

Source:
Returns:

resolved status value

Type
baja.Status

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

Description:

  • Make a Status.

Source:
Example
//The bits (Number) or (for more arguments) an Object Literal can be 
  //used to specify the method's arguments.
  var st1 = baja.Status.make(baja.Status.DOWN | baja.Status.FAULT);
  
  // ... or for more arguments...
  
  var st2 = baja.Status.make({
    bits: baja.Status.DOWN,
    facets: facets
  });
  
  //The make() method can also be used to create a new status with its 
  //state changed...

  var newStatus = baja.Status.make({
    orig: oldStatus, 
    bits: baja.Status.OVERRIDDEN, 
    state: true
  }};
Parameters:
Name Type Description
obj Object | Number

the Object Literal that specifies the method's arguments or Status bits.

Properties
Name Type Attributes Description
bits Number

the Status bits.
facets baja.Facets <optional>

the facets for the Status.
orig baja.Status <optional>

if defined, obj.state must also be defined. This is used to create
a new Status with one of it's bit states changed (see example above).
state Boolean <optional>

the state of the bit to change (used in conjunction with obj.orig).
Returns:

the status.

Type
baja.Status