new Flags()
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.
Extends
Members
-
<static> ASYNC :Number
-
async flag.
Type:
- Number
-
<static> COMPOSITE :Number
-
composite flag.
Type:
- Number
-
<static> CONFIRM_REQUIRED :Number
-
confirmRequired flag.
Type:
- Number
-
<static> DEFAULT_ON_CLONE :Number
-
defaultOnClone flag.
Type:
- Number
-
<static> EXECUTE_ON_CHANGE :Number
-
executeOnChange flag.
Type:
- Number
-
<static> FAN_IN :Number
-
fanIn flag.
Type:
- Number
-
<static> HIDDEN :Number
-
hidden flag.
Type:
- Number
-
<static> LINK_TARGET :Number
-
linkTarget flag.
Type:
- Number
-
<static> METADATA :Number
-
metaData flag.
Type:
- Number
-
<static> NO_AUDIT :Number
-
noAudit flag.
Type:
- Number
-
<static> NO_RUN :Number
-
noRun flag.
Type:
- Number
-
<static> NON_CRITICAL :Number
-
nonCritical flag.
Type:
- Number
-
<static> OPERATOR :Number
-
operator flag.
Type:
- Number
-
<static> READONLY :Number
-
readonly flag.
Type:
- Number
-
<static> REMOVE_ON_CLONE :Number
-
removeOnClone flag.
Type:
- Number
-
<static> SUMMARY :Number
-
summary flag.
Type:
- Number
-
<static> TRANSIENT :Number
-
transient flag.
Type:
- Number
-
<static> USER_DEFINED_1 :Number
-
userDefined1 flag.
Type:
- Number
-
<static> USER_DEFINED_2 :Number
-
userDefined2 flag.
Type:
- Number
-
<static> USER_DEFINED_3 :Number
-
userDefined3 flag.
Type:
- Number
-
<static> USER_DEFINED_4 :Number
-
userDefined4 flag.
Type:
- Number
Methods
-
<static> decodeFromString(flagsStr)
-
Decode Slot Flags from a
String
.Parameters:
Name Type Description flagsStr
String the
Flags
encoded as aString
.Returns:
- Type
- Number
-
<static> encodeToString(flags)
-
Encode Slot Flags to a
String
.Parameters:
Name Type Description flags
Number the flags to be encoded.
Returns:
- Type
- String
-
equals(obj)
-
Equality test.
Parameters:
Name Type Description obj
- Overrides:
Returns:
- Type
- Boolean
-
getMask()
-
Return the mask for the
Flags
.Returns:
- Type
- Number
-
getSymbol()
-
Return the symbol for the
Flags
.Returns:
- Type
- String
-
toString()
-
Return the
String
representation of theFlags
.Returns:
- Type
- String
-
valueOf()
-
Return the inner value of the object.
By default the object's instance is returned.
- Inherited From:
Returns:
the inner value of the object or just the object's instance.
- Type
- *