Flags

baja. Flags

new Flags()

Description:

  • Slot Flags.

    Flags are boolean values which are stored as
    a bitmask on each slot in a Complex. Some
    flags apply to all slot types, while some only
    have meaning for certain slot types.

    Flags should always be a Number. This Constructor should only be
    used to create new objects by Tridium developers.

Source:

Extends

Members

(static) ASYNC :Number

Description:

  • async flag.

Source:

async flag.

Type:
  • Number

(static) COMPOSITE :Number

Description:

  • composite flag.

Source:

composite flag.

Type:
  • Number

(static) CONFIRM_REQUIRED :Number

Description:

  • confirmRequired flag.

Source:

confirmRequired flag.

Type:
  • Number

(static) DEFAULT_ON_CLONE :Number

Description:

  • defaultOnClone flag.

Source:

defaultOnClone flag.

Type:
  • Number

(static) EXECUTE_ON_CHANGE :Number

Description:

  • executeOnChange flag.

Source:

executeOnChange flag.

Type:
  • Number

(static) FAN_IN :Number

Description:

  • fanIn flag.

Source:

fanIn flag.

Type:
  • Number

(static) HIDDEN :Number

Description:

  • hidden flag.

Source:

hidden flag.

Type:
  • Number
Description:

  • linkTarget flag.

Source:

linkTarget flag.

Type:
  • Number

(static) METADATA :Number

Description:

  • metaData flag.

Source:

metaData flag.

Type:
  • Number

(static) NON_CRITICAL :Number

Description:

  • nonCritical flag.

Source:

nonCritical flag.

Type:
  • Number

(static) NO_AUDIT :Number

Description:

  • noAudit flag.

Source:

noAudit flag.

Type:
  • Number

(static) NO_RUN :Number

Description:

  • noRun flag.

Source:

noRun flag.

Type:
  • Number

(static) OPERATOR :Number

Description:

  • operator flag.

Source:

operator flag.

Type:
  • Number

(static) READONLY :Number

Description:

  • readonly flag.

Source:

readonly flag.

Type:
  • Number

(static) REMOVE_ON_CLONE :Number

Description:

  • removeOnClone flag.

Source:

removeOnClone flag.

Type:
  • Number

(static) SUMMARY :Number

Description:

  • summary flag.

Source:

summary flag.

Type:
  • Number

(static) TRANSIENT :Number

Description:

  • transient flag.

Source:

transient flag.

Type:
  • Number

(static) USER_DEFINED_1 :Number

Description:

  • userDefined1 flag.

Source:

userDefined1 flag.

Type:
  • Number

(static) USER_DEFINED_2 :Number

Description:

  • userDefined2 flag.

Source:

userDefined2 flag.

Type:
  • Number

(static) USER_DEFINED_3 :Number

Description:

  • userDefined3 flag.

Source:

userDefined3 flag.

Type:
  • Number

(static) USER_DEFINED_4 :Number

Description:

  • userDefined4 flag.

Source:

userDefined4 flag.

Type:
  • Number

Methods

equals(obj) → {Boolean}

Description:

  • Equality test.

Source:
Overrides:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

getMask() → {Number}

Description:

  • Return the mask for the Flags.

Source:
Returns:
Type
Number

getSymbol() → {String}

Description:

  • Return the symbol for the Flags.

Source:
Returns:
Type
String

toString() → {String}

Description:

  • Return the String representation of the Flags.

Source:
Returns:
Type
String

valueOf() → {*}

Description:

  • Return the inner value of the object.

    By default the object's instance is returned.

Source:
Inherited From:
Returns:

the inner value of the object or just the object's instance.

Type
*

(static) decodeFromString(flagsStr) → {Number}

Description:

  • Decode Slot Flags from a String.

Source:
Parameters:
Name Type Description
flagsStr String

the Flags encoded as a String.
Returns:
Type
Number

(static) encodeToString(flags) → {String}

Description:

  • Encode Slot Flags to a String.

Source:
Parameters:
Name Type Description
flags Number

the flags to be encoded.
Returns:
Type
String