T
- public class CommonAlarmProperties<T extends java.io.Serializable> extends WellKnownAlarmProperties<T>
WellKnownAlarmPropertyDirectory
.Modifier and Type | Class and Description |
---|---|
protected static class |
CommonAlarmProperties.CalculatedAlarmProperty<R extends java.io.Serializable> |
Modifier and Type | Field and 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> |
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> |
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.Boolean> |
LegacySendClear |
static CommonAlarmProperties<java.lang.String> |
Name |
static CommonAlarmProperties<java.lang.String> |
Notes |
static java.util.List<AlarmProperty<?>> |
OTHER_PROPERTIES
Any remaining properties, for translation
|
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 CommonAlarmProperties<java.util.Date> |
ShelfExpiration |
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 and 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) |
Modifier and Type | Method and Description |
---|---|
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() |
equals, getDefaultValue, getName, getType, hashCode, isAdvanced, isBindable, name, toString, values
public static final CommonAlarmProperties<java.lang.String> Name
public static final CommonAlarmProperties<java.lang.Boolean> Enabled
public static final CommonAlarmProperties<AlarmPriority> Priority
public static final CommonAlarmProperties<java.lang.String> DisplayPath
public static final CommonAlarmProperties<java.lang.String> ActivePipeline
public static final CommonAlarmProperties<java.lang.String> ClearPipeline
public static final CommonAlarmProperties<java.lang.String> AckPipeline
public static final CommonAlarmProperties<java.lang.Double> Deadband
public static final CommonAlarmProperties<DeadbandMode> DeadbandEvalMode
public static final CommonAlarmProperties<java.lang.Double> TimeOnDelaySeconds
public static final CommonAlarmProperties<java.lang.Double> TimeOffDelaySeconds
public static final CommonAlarmProperties<TimestampSource> TimestampSource
public static final CommonAlarmProperties<AlertAckMode> AckMode
public static final CommonAlarmProperties<java.lang.String> Notes
public static final CommonAlarmProperties<java.lang.Boolean> AckNotesReqd
public static final CommonAlarmProperties<java.lang.Boolean> ShelvingAllowed
public static final CommonAlarmProperties<java.lang.Boolean> IsSystemEvent
public static final CommonAlarmProperties<java.lang.Boolean> IsInitialEvent
public static final CommonAlarmProperties<java.lang.Boolean> SystemAck
public static final CommonAlarmProperties<java.lang.Boolean> IsShelved
public static final CommonAlarmProperties<java.util.Date> ShelfExpiration
public static final CommonAlarmProperties<java.lang.Boolean> EventCanceled
public static final CommonAlarmProperties<java.lang.String> Filter
public static final CommonAlarmProperties<java.util.UUID> EventId
public static final CommonAlarmProperties<QualifiedPath> Source
public static final CommonAlarmProperties<AlarmState> State
public static final CommonAlarmProperties<AlarmStateTransition> EventState
public static final CommonAlarmProperties<java.util.Date> EventTime
public static final CommonAlarmProperties<java.io.Serializable> EventValue
public static final CommonAlarmProperties<QualifiedPath> AckUser
public static final CommonAlarmProperties<java.lang.String> AckUserName
public static final CommonAlarmProperties<java.lang.String> AckNotes
public static final CommonAlarmProperties<java.lang.Boolean> IsAcked
public static final CommonAlarmProperties<java.lang.Boolean> IsActive
public static final CommonAlarmProperties<java.lang.Boolean> IsClear
public static final CommonAlarmProperties<java.util.Date> ActiveTime
public static final CommonAlarmProperties<java.util.Date> ClearTime
public static final CommonAlarmProperties<java.util.Date> AckTime
public static final CommonAlarmProperties<java.lang.String> ActiveDuration
public static final CommonAlarmProperties<java.lang.Integer> ActiveDurationMS
public static final CommonAlarmProperties<java.lang.String> AckDuration
public static final CommonAlarmProperties<java.lang.Integer> AckDurationMS
public static final CommonAlarmProperties<java.lang.String> DisplayPathOrSource
@Nullable public static final CommonAlarmProperties<java.lang.String> ItemPath
@Nonnull public static final CommonAlarmProperties<java.lang.String> FullItemPath
@Nonnull public static final CommonAlarmProperties<java.lang.String> ItemName
public static final CommonAlarmProperties<java.lang.Integer> BranchDepth
public static final CommonAlarmProperties<java.lang.Integer> PipelineTransitionCount
public static final CommonAlarmProperties<java.lang.Boolean> LegacySendClear
public static final java.util.List<AlarmProperty<?>> CONFIG_PROPS
public static final java.util.List<AlarmProperty<?>> BASIC_BINDABLE_PROPS
public static final java.util.List<AlarmProperty<?>> INFO_PROPERTIES
public static final java.util.List<AlarmProperty<?>> OTHER_PROPERTIES
public CommonAlarmProperties()
public CommonAlarmProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal)
public CommonAlarmProperties(java.lang.String simpleName, java.lang.String category, java.lang.Class<T> dtype, T defaultVal)
@Deprecated public CommonAlarmProperties(java.lang.String simpleName, java.lang.String category, java.lang.Class<T> dtype, java.lang.Object defaultVal, boolean bindable)
public java.lang.String getCategoryKey()
protected java.lang.String getBundleKeyBase()
public LocalizedString getDisplayName()
DescriptiveProperty
public LocalizedString getCategory()
DescriptiveProperty
public LocalizedString getDescription()
DescriptiveProperty
public static AlarmProperty<?>[] values()