Class CommonAlarmProperties<T extends java.io.Serializable>
- java.lang.Object
-
- com.inductiveautomation.ignition.common.alarming.config.WellKnownAlarmProperties<T>
-
- com.inductiveautomation.ignition.common.alarming.config.CommonAlarmProperties<T>
-
- All Implemented Interfaces:
AlarmProperty<T>
,DescriptiveProperty<T>
,Property<T>
,java.io.Serializable
- Direct Known Subclasses:
CommonAlarmProperties.CalculatedAlarmProperty
public class CommonAlarmProperties<T extends java.io.Serializable> extends WellKnownAlarmProperties<T>
These are many of the properties that are used throughout the alarming system, provided/known by Ignition. Some of them are for configuration, and others are only used during runtime/execution. They all extend fromAlarmProperty
, so they can have a descriptive name, and a category, if appropriate. Both of those properties will be used in display, either on the configuration screen, or in code-assist situations like expression editors and other binding locations.All property IDs should follow the standard camel-case, lower first letter convention. These will be displayed and used in bindings.
The values of this class are registered with the
WellKnownAlarmPropertyDirectory
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
CommonAlarmProperties.CalculatedAlarmProperty<R extends java.io.Serializable>
-
Field Summary
Fields Modifier and Type Field Description static CommonAlarmProperties<java.lang.String>
AckDuration
Elapsed time between ActiveTime and AckTime.static CommonAlarmProperties<java.lang.Integer>
AckDurationMS
Elapsed time between ActiveTime and AckTime.static CommonAlarmProperties<AlertAckMode>
AckMode
static CommonAlarmProperties<java.lang.String>
AckNotes
static CommonAlarmProperties<java.lang.Boolean>
AckNotesReqd
static CommonAlarmProperties<java.lang.String>
AckPipeline
static CommonAlarmProperties<java.util.Date>
AckTime
static CommonAlarmProperties<QualifiedPath>
AckUser
The user who acknowledged the alarm, specified by an QualifiedPath that points to the user source and id.static CommonAlarmProperties<java.lang.String>
AckUserName
This calculated helper property provides a friendlier display version of the ack user property.static CommonAlarmProperties<java.lang.String>
ActiveDuration
Elapsed time between ActiveTime and ClearTime.static CommonAlarmProperties<java.lang.Integer>
ActiveDurationMS
Elapsed time between ActiveTime and ClearTime, in milliseconds.static CommonAlarmProperties<java.lang.String>
ActivePipeline
static CommonAlarmProperties<java.util.Date>
ActiveTime
static java.util.List<AlarmProperty<?>>
BASIC_BINDABLE_PROPS
These are the basic properties that are displayed for most binding contexts.static CommonAlarmProperties<java.lang.Integer>
BranchDepth
Each time an alarm event is split in a pipeline, a new branch or instance is created.static CommonAlarmProperties<java.lang.String>
ClearPipeline
static CommonAlarmProperties<java.util.Date>
ClearTime
static java.util.List<AlarmProperty<?>>
CONFIG_PROPS
These are the properties that are shown for configuration on all alarms.static CommonAlarmProperties<java.lang.Double>
Deadband
static CommonAlarmProperties<DeadbandMode>
DeadbandEvalMode
static CommonAlarmProperties<java.lang.String>
DisplayPath
static CommonAlarmProperties<java.lang.String>
DisplayPathOrSource
This path is going to be the string version of either the display path, if defined, or the source path.static CommonAlarmProperties<java.lang.Boolean>
Enabled
static CommonAlarmProperties<java.lang.Boolean>
EventCanceled
This gets set to TRUE if the event should drop out of any pipeline that it is in - canceling any pending notification activities.static CommonAlarmProperties<java.util.UUID>
EventId
static CommonAlarmProperties<AlarmStateTransition>
EventState
The most recent or most appropriate state transition of the event.static CommonAlarmProperties<java.util.Date>
EventTime
static CommonAlarmProperties<java.io.Serializable>
EventValue
static CommonAlarmProperties<java.lang.String>
Filter
The string representation of an AlarmFilter.static CommonAlarmProperties<java.lang.String>
FullItemPath
Much like ItemPath, but will include everything in the source path, such as the provider, project, etc.static java.util.List<AlarmProperty<?>>
INFO_PROPERTIES
These are properties that aren't config, but are used to get useful information, or calculated/derived values.static CommonAlarmProperties<java.lang.Boolean>
IsAcked
static CommonAlarmProperties<java.lang.Boolean>
IsActive
static CommonAlarmProperties<java.lang.Boolean>
IsClear
static CommonAlarmProperties<java.lang.Boolean>
IsDisabledEvent
static CommonAlarmProperties<java.lang.Boolean>
IsEnabledEvent
static CommonAlarmProperties<java.lang.Boolean>
IsInitialEvent
Indicates that this (active) event has been caused by the initial value of a tag, either during load, or due to the tag's enabled state.static CommonAlarmProperties<java.lang.Boolean>
IsJournaled
static CommonAlarmProperties<java.lang.Boolean>
IsReleased
This property is only used for internal communication of events that have been disconnected from their source alarms, usually due to the alarm going to disabled.static CommonAlarmProperties<java.lang.Boolean>
IsShelved
static CommonAlarmProperties<java.lang.Boolean>
IsSystemEvent
This boolean indicates whether the event is a "system" event.static CommonAlarmProperties<java.lang.String>
ItemName
This helper property provides the name of the item holding the alarm, without its path *static CommonAlarmProperties<java.lang.String>
ItemPath
This helper property should provide the path of the item holding the alarm.static CommonAlarmProperties<java.lang.String>
Label
static CommonAlarmProperties<java.lang.Boolean>
LegacySendClear
static CommonAlarmProperties<java.lang.String>
Name
static CommonAlarmProperties<java.lang.String>
Notes
static AlarmModeProperties<java.lang.Boolean>
NotifyInitialEvent
This is a special api setting that indicates that we should ignore the concept of "initial" events and always notify, regardless of the gateway settings that may prevent initial notification.static java.util.List<AlarmProperty<?>>
OTHER_PROPERTIES
Any remaining properties, for translationstatic CommonAlarmProperties<java.lang.String>
PipelineProject
The name of the Project that the pipelines specified byActivePipeline
,ClearPipeline
, andAckPipeline
reside in.static CommonAlarmProperties<java.lang.Integer>
PipelineTransitionCount
This property is incremented each time the alarm transitions from block to block during execution.static CommonAlarmProperties<AlarmPriority>
Priority
static java.util.List<AlarmProperty<?>>
RUNTIME_PROPERTIES
These are properties that do not allow configuration, as they only exist during runtime or execution.static CommonAlarmProperties<java.util.Date>
ShelfExpiration
static CommonAlarmProperties<QualifiedPath>
ShelfUser
static CommonAlarmProperties<java.lang.Boolean>
ShelvingAllowed
static CommonAlarmProperties<QualifiedPath>
Source
static CommonAlarmProperties<AlarmState>
State
Alarm state is the full current state of an alarm in one enum, such as ActiveAcked.static CommonAlarmProperties<java.lang.Boolean>
SystemAck
static CommonAlarmProperties<java.lang.Double>
TimeOffDelaySeconds
static CommonAlarmProperties<java.lang.Double>
TimeOnDelaySeconds
static CommonAlarmProperties<TimestampSource>
TimestampSource
-
Constructor Summary
Constructors Constructor Description CommonAlarmProperties()
Only for serialization.CommonAlarmProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal)
CommonAlarmProperties(java.lang.String simpleName, java.lang.String category, java.lang.Class<T> dtype, java.lang.Object defaultVal, boolean bindable)
Deprecated.CommonAlarmProperties(java.lang.String simpleName, java.lang.String category, java.lang.Class<T> dtype, T defaultVal)
CommonAlarmProperties(java.lang.String simpleName, java.lang.String category, java.lang.Class<T> dtype, T defaultVal, boolean bindable)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.String
formatDuration(java.util.Date activeTime, java.util.Date otherTime, FormatUtil.DurationFormatStyle format)
protected java.lang.String
getBundleKeyBase()
LocalizedString
getCategory()
The category under which this property will be placed when editing.java.lang.String
getCategoryKey()
LocalizedString
getDescription()
Optional description/documentation for the property.LocalizedString
getDisplayName()
A friendly display name for the property.static AlarmProperty<?>[]
values()
-
Methods inherited from class com.inductiveautomation.ignition.common.alarming.config.WellKnownAlarmProperties
equals, getDefaultValue, getName, getType, hashCode, isAdvanced, isBindable, name, toString, values
-
-
-
-
Field Detail
-
Name
public static final CommonAlarmProperties<java.lang.String> Name
-
Enabled
public static final CommonAlarmProperties<java.lang.Boolean> Enabled
-
Priority
public static final CommonAlarmProperties<AlarmPriority> Priority
-
Label
public static final CommonAlarmProperties<java.lang.String> Label
-
DisplayPath
public static final CommonAlarmProperties<java.lang.String> DisplayPath
-
PipelineProject
public static final CommonAlarmProperties<java.lang.String> PipelineProject
The name of the Project that the pipelines specified byActivePipeline
,ClearPipeline
, andAckPipeline
reside in.
-
ActivePipeline
public static final CommonAlarmProperties<java.lang.String> ActivePipeline
-
ClearPipeline
public static final CommonAlarmProperties<java.lang.String> ClearPipeline
-
AckPipeline
public static final CommonAlarmProperties<java.lang.String> AckPipeline
-
Deadband
public static final CommonAlarmProperties<java.lang.Double> Deadband
-
DeadbandEvalMode
public static final CommonAlarmProperties<DeadbandMode> DeadbandEvalMode
-
TimeOnDelaySeconds
public static final CommonAlarmProperties<java.lang.Double> TimeOnDelaySeconds
-
TimeOffDelaySeconds
public static final CommonAlarmProperties<java.lang.Double> TimeOffDelaySeconds
-
TimestampSource
public static final CommonAlarmProperties<TimestampSource> TimestampSource
-
AckMode
public static final CommonAlarmProperties<AlertAckMode> AckMode
-
Notes
public static final CommonAlarmProperties<java.lang.String> Notes
-
AckNotesReqd
public static final CommonAlarmProperties<java.lang.Boolean> AckNotesReqd
-
ShelvingAllowed
public static final CommonAlarmProperties<java.lang.Boolean> ShelvingAllowed
-
NotifyInitialEvent
public static final AlarmModeProperties<java.lang.Boolean> NotifyInitialEvent
This is a special api setting that indicates that we should ignore the concept of "initial" events and always notify, regardless of the gateway settings that may prevent initial notification.
-
IsSystemEvent
public static final CommonAlarmProperties<java.lang.Boolean> IsSystemEvent
This boolean indicates whether the event is a "system" event. System events are special in that by default, they get included in all Journal queries.
-
IsJournaled
public static final CommonAlarmProperties<java.lang.Boolean> IsJournaled
-
IsInitialEvent
public static final CommonAlarmProperties<java.lang.Boolean> IsInitialEvent
Indicates that this (active) event has been caused by the initial value of a tag, either during load, or due to the tag's enabled state.
-
SystemAck
public static final CommonAlarmProperties<java.lang.Boolean> SystemAck
-
IsEnabledEvent
public static final CommonAlarmProperties<java.lang.Boolean> IsEnabledEvent
-
IsDisabledEvent
public static final CommonAlarmProperties<java.lang.Boolean> IsDisabledEvent
-
IsShelved
public static final CommonAlarmProperties<java.lang.Boolean> IsShelved
-
ShelfExpiration
public static final CommonAlarmProperties<java.util.Date> ShelfExpiration
-
ShelfUser
public static final CommonAlarmProperties<QualifiedPath> ShelfUser
-
EventCanceled
public static final CommonAlarmProperties<java.lang.Boolean> EventCanceled
This gets set to TRUE if the event should drop out of any pipeline that it is in - canceling any pending notification activities.
-
Filter
public static final CommonAlarmProperties<java.lang.String> Filter
The string representation of an AlarmFilter. Not parsable, just used for history/reference.
-
EventId
public static final CommonAlarmProperties<java.util.UUID> EventId
-
Source
public static final CommonAlarmProperties<QualifiedPath> Source
-
State
public static final CommonAlarmProperties<AlarmState> State
Alarm state is the full current state of an alarm in one enum, such as ActiveAcked. This is in comparison to the EventState property, which is the specific change that has most recently occurred.
-
EventState
public static final CommonAlarmProperties<AlarmStateTransition> EventState
The most recent or most appropriate state transition of the event. Not the full state of the alarm event, which is provided by the "State" property.
-
EventTime
public static final CommonAlarmProperties<java.util.Date> EventTime
-
EventValue
public static final CommonAlarmProperties<java.io.Serializable> EventValue
-
AckUser
public static final CommonAlarmProperties<QualifiedPath> AckUser
The user who acknowledged the alarm, specified by an QualifiedPath that points to the user source and id. *
-
AckUserName
@Nullable public static final CommonAlarmProperties<java.lang.String> AckUserName
This calculated helper property provides a friendlier display version of the ack user property. *
-
AckNotes
public static final CommonAlarmProperties<java.lang.String> AckNotes
-
IsAcked
public static final CommonAlarmProperties<java.lang.Boolean> IsAcked
-
IsActive
public static final CommonAlarmProperties<java.lang.Boolean> IsActive
-
IsClear
public static final CommonAlarmProperties<java.lang.Boolean> IsClear
-
ActiveTime
public static final CommonAlarmProperties<java.util.Date> ActiveTime
-
ClearTime
public static final CommonAlarmProperties<java.util.Date> ClearTime
-
AckTime
public static final CommonAlarmProperties<java.util.Date> AckTime
-
IsReleased
public static final CommonAlarmProperties<java.lang.Boolean> IsReleased
This property is only used for internal communication of events that have been disconnected from their source alarms, usually due to the alarm going to disabled. It should not be used externally to look up state.
-
ActiveDuration
public static final CommonAlarmProperties<java.lang.String> ActiveDuration
Elapsed time between ActiveTime and ClearTime.
-
ActiveDurationMS
public static final CommonAlarmProperties<java.lang.Integer> ActiveDurationMS
Elapsed time between ActiveTime and ClearTime, in milliseconds. If not clear, calculates to the current time.
-
AckDuration
public static final CommonAlarmProperties<java.lang.String> AckDuration
Elapsed time between ActiveTime and AckTime.
-
AckDurationMS
public static final CommonAlarmProperties<java.lang.Integer> AckDurationMS
Elapsed time between ActiveTime and AckTime.
-
DisplayPathOrSource
public static final CommonAlarmProperties<java.lang.String> DisplayPathOrSource
This path is going to be the string version of either the display path, if defined, or the source path. *
-
ItemPath
@Nullable public static final CommonAlarmProperties<java.lang.String> ItemPath
This helper property should provide the path of the item holding the alarm. It also includes the item name. It does not, however, include anything above the item path in the full source path (for that, use FullItemPath).
-
FullItemPath
@Nonnull public static final CommonAlarmProperties<java.lang.String> FullItemPath
Much like ItemPath, but will include everything in the source path, such as the provider, project, etc.
-
ItemName
@Nonnull public static final CommonAlarmProperties<java.lang.String> ItemName
This helper property provides the name of the item holding the alarm, without its path *
-
BranchDepth
public static final CommonAlarmProperties<java.lang.Integer> BranchDepth
Each time an alarm event is split in a pipeline, a new branch or instance is created. This property can be used to see and limit how many times has has or can happen.
-
PipelineTransitionCount
public static final CommonAlarmProperties<java.lang.Integer> PipelineTransitionCount
This property is incremented each time the alarm transitions from block to block during execution. The pipelines limit the number of times an event can be transferred, in order to prevent infinite loops.
-
LegacySendClear
public static final CommonAlarmProperties<java.lang.Boolean> LegacySendClear
-
CONFIG_PROPS
public static final java.util.List<AlarmProperty<?>> CONFIG_PROPS
These are the properties that are shown for configuration on all alarms. Based on the mode, different properties are shown (those are defined in AlarmModeProperties)
-
BASIC_BINDABLE_PROPS
public static final java.util.List<AlarmProperty<?>> BASIC_BINDABLE_PROPS
These are the basic properties that are displayed for most binding contexts. Other properties can be referenced, but these the the common properties defined in this class that are generally referenced.
-
INFO_PROPERTIES
public static final java.util.List<AlarmProperty<?>> INFO_PROPERTIES
These are properties that aren't config, but are used to get useful information, or calculated/derived values.
-
OTHER_PROPERTIES
public static final java.util.List<AlarmProperty<?>> OTHER_PROPERTIES
Any remaining properties, for translation
-
RUNTIME_PROPERTIES
public static final java.util.List<AlarmProperty<?>> RUNTIME_PROPERTIES
These are properties that do not allow configuration, as they only exist during runtime or execution.
-
-
Constructor Detail
-
CommonAlarmProperties
public CommonAlarmProperties()
Only for serialization. *
-
CommonAlarmProperties
public CommonAlarmProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal)
-
CommonAlarmProperties
public CommonAlarmProperties(java.lang.String simpleName, java.lang.String category, java.lang.Class<T> dtype, T defaultVal)
-
CommonAlarmProperties
@Deprecated public CommonAlarmProperties(java.lang.String simpleName, java.lang.String category, java.lang.Class<T> dtype, java.lang.Object defaultVal, boolean bindable)
Deprecated.This is only to work around an apparent problem with type detection in xml serialization. *
-
-
Method Detail
-
formatDuration
public static java.lang.String formatDuration(java.util.Date activeTime, java.util.Date otherTime, FormatUtil.DurationFormatStyle format)
-
getCategoryKey
public java.lang.String getCategoryKey()
-
getBundleKeyBase
protected java.lang.String getBundleKeyBase()
-
getDisplayName
public LocalizedString getDisplayName()
Description copied from interface:DescriptiveProperty
A friendly display name for the property. If not set, will return a raw LocalizedString that contains the property name.
-
getCategory
public LocalizedString getCategory()
Description copied from interface:DescriptiveProperty
The category under which this property will be placed when editing.
-
getDescription
public LocalizedString getDescription()
Description copied from interface:DescriptiveProperty
Optional description/documentation for the property. May return null if no information is available.
-
values
public static AlarmProperty<?>[] values()
-
-