Package com.inductiveautomation.ignition.common.sqltags.model

Enum Class TagProp

java.lang.Object
java.lang.Enum<TagProp>
com.inductiveautomation.ignition.common.sqltags.model.TagProp
All Implemented Interfaces:
Property<Object>, Serializable, Comparable<TagProp>, Constable
public enum TagProp extends Enum<TagProp> implements Property<Object>

  • Enum Constant Details

    • Value

      public static final TagProp Value

    • Name

      public static final TagProp Name

    • Quality

      public static final TagProp Quality

    • Enabled

      public static final TagProp Enabled

    • AccessRights

      public static final TagProp AccessRights

    • OPCServer

      public static final TagProp OPCServer

    • OPCItemPath

      public static final TagProp OPCItemPath

    • OPCWriteBackServer

      public static final TagProp OPCWriteBackServer

    • OPCWriteBackItemPath

      public static final TagProp OPCWriteBackItemPath

    • ScaleMode

      public static final TagProp ScaleMode

    • RawLow

      public static final TagProp RawLow

    • RawHigh

      public static final TagProp RawHigh

    • ScaledLow

      public static final TagProp ScaledLow

    • ScaledHigh

      public static final TagProp ScaledHigh

    • ClampMode

      public static final TagProp ClampMode

    • Deadband

      public static final TagProp Deadband

    • FormatString

      public static final TagProp FormatString

    • EngUnit

      public static final TagProp EngUnit

    • Tooltip

      public static final TagProp Tooltip

    • EngHigh

      public static final TagProp EngHigh

    • EngLow

      public static final TagProp EngLow

    • Documentation

      public static final TagProp Documentation

    • Expression

      public static final TagProp Expression

    • ExpressionType

      public static final TagProp ExpressionType

    • AlertMode

      public static final TagProp AlertMode

    • AlertAckMode

      public static final TagProp AlertAckMode

    • AlertSendClear

      public static final TagProp AlertSendClear

    • AlertMessageMode

      public static final TagProp AlertMessageMode

    • AlertMessage

      public static final TagProp AlertMessage

    • AlertNotes

      public static final TagProp AlertNotes

    • AlertDisplayPath

      public static final TagProp AlertDisplayPath

    • AlertDeadband

      public static final TagProp AlertDeadband

    • LastChange

      public static final TagProp LastChange

    • DriverName

      public static final TagProp DriverName

    • ScanClass

      public static final TagProp ScanClass

    • PollRate

      public static final TagProp PollRate

    • SQLBindingDatasource

      public static final TagProp SQLBindingDatasource

    • PrimaryHistoryProvider

      public static final TagProp PrimaryHistoryProvider

    • HistoricalDeadband

      public static final TagProp HistoricalDeadband

    • HistoryEnabled

      public static final TagProp HistoryEnabled

    • HistoricalScanclass

      public static final TagProp HistoricalScanclass

    • InterpolationMode

      public static final TagProp InterpolationMode

    • AlertExecEnabled

      public static final TagProp AlertExecEnabled

    • AlertActive

      public static final TagProp AlertActive

    • AlertCurrentState

      public static final TagProp AlertCurrentState

    • AlertCurrentSeverity

      public static final TagProp AlertCurrentSeverity

    • AlertAcknowledged

      public static final TagProp AlertAcknowledged

    • AlertAcknowledgeUser

      public static final TagProp AlertAcknowledgeUser

    • AlertActiveTime

      public static final TagProp AlertActiveTime

    • AlertAcknowledgedTime

      public static final TagProp AlertAcknowledgedTime

    • AlertClearedTime

      public static final TagProp AlertClearedTime

    • AlertTimestampSource

      public static final TagProp AlertTimestampSource

    • AlertMessageSubject

      public static final TagProp AlertMessageSubject

    • HistoryTimestampSource

      public static final TagProp HistoryTimestampSource

    • HistoryMaxAgeMode

      public static final TagProp HistoryMaxAgeMode
      Max age mode is defined as the int value of the AgeRestriction enum *

    • HistoryMaxAge

      public static final TagProp HistoryMaxAge

    • DataType

      public static final TagProp DataType

    • TagTypeSubCode

      public static final TagProp TagTypeSubCode

    • TagType

      public static final TagProp TagType

    • UDTParentType

      public static final TagProp UDTParentType

    • ExtendedProperties

      public static final TagProp ExtendedProperties

    • PropertyOverrides

      public static final TagProp PropertyOverrides

    • UDTMemberUID

      public static final TagProp UDTMemberUID

    • AlarmActiveUnackCount

      public static final TagProp AlarmActiveUnackCount

    • AlarmActiveAckCount

      public static final TagProp AlarmActiveAckCount

    • ScaleFactor

      public static final TagProp ScaleFactor

    • EngLimitMode

      public static final TagProp EngLimitMode

    • AlarmClearUnackCount

      public static final TagProp AlarmClearUnackCount

    • AlarmHighestUnackPriority

      public static final TagProp AlarmHighestUnackPriority

    • AlarmHighestUnackName

      public static final TagProp AlarmHighestUnackName

    • AlarmHighestAckName

      public static final TagProp AlarmHighestAckName

    • AlarmHighestAckPriority

      public static final TagProp AlarmHighestAckPriority

    • DeadbandMode

      public static final TagProp DeadbandMode

    • HistoricalDeadbandMode

      public static final TagProp HistoricalDeadbandMode

    • EventScripts

      public static final TagProp EventScripts

    • QueryType

      public static final TagProp QueryType

    • RuntimeQuality

      public static final TagProp RuntimeQuality

    • AlarmShelvedCount

      public static final TagProp AlarmShelvedCount

    • PersistValue

      public static final TagProp PersistValue

    • SourceDataType

      public static final TagProp SourceDataType

    • SourceTagPath

      public static final TagProp SourceTagPath

    • DeriveExpressionGetter

      public static final TagProp DeriveExpressionGetter

    • DeriveExpressionSetter

      public static final TagProp DeriveExpressionSetter

    • QueryParameters

      public static final TagProp QueryParameters

    • BrowseValue

      public static final TagProp BrowseValue

  • Method Details

    • values

      public static TagProp[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TagProp valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getProp

      public static TagProp getProp(String name)
      Returns the TagProp for the given name (Case insensitive). Returns null if there is no TagProp of that name.

    • isTagProp

      public static boolean isTagProp(String name)

    • getName

      public String getName()
      Description copied from interface: Property
      The "name" of this property. Should be descriptive, but also unique. To this end, it is encouraged to make your keys fully qualified by prefixing them with your module id. For example: "mymod.MyProperty". Properties defined by the system start with "sys."
      Specified by:
      getName in interface Property<Object>

    • isWriteable

      public boolean isWriteable()

    • isAttribute

      public boolean isAttribute()
      Returns true if this tag prop should be accessed through Tag.getAttribute(), or if it is a virtual property (Value, Name, Quality, Enabled, and LastChange are all the "Virtual" propreties)

    • isTransient

      public boolean isTransient()

    • getType

      public Class getType()
      Returns the type of the tag property. Some tag properties (notable the value property) can have variable type, in which case this will return Object
      Specified by:
      getType in interface Property<Object>

    • getDefaultValue

      public Object getDefaultValue()
      Returns the default value for this tag property.
      Specified by:
      getDefaultValue in interface Property<Object>

    • getTypeClass

      public DataTypeClass getTypeClass()

    • isRuntimeProperty

      public boolean isRuntimeProperty()
      Returns whether this is property that can be updated on the fly, without reloading the tag. In other words, not a core configuration property.

    • shouldIntern

      public boolean shouldIntern()
      Returns whether the string value of this property should be "interned" for performance.

    • setOf

      public static Set<TagProp> setOf(TagProp... props)

    • fullSet

      public static Set<TagProp> fullSet()

    • property

      public Property property()
      TagProp implements Property. However, it cannot properly implement the hashCode() and equals() functions as the Property interface dictates. So, we have this wrapper, which is safe for use in property sets and other places where hashing is required.