com.inductiveautomation.ignition.common.alarming.evaluation

Class EventProperty

java.lang.Object

com.inductiveautomation.ignition.common.alarming.evaluation.EventProperty

All Implemented Interfaces:

Property, java.io.Serializable

public class EventProperty
extends java.lang.Object
implements Property

This wrapper around Property adds information about what kind of property it is. It is only used by the alarming system, and is primarily used when trying to decide what should be journaled.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Property<?>	internal
protected EventPropertyType	type

Constructor Summary

Constructors

Constructor and Description
EventProperty(Property<?> prop, EventPropertyType type)

Method Summary

Modifier and Type	Method and Description
static EventProperty	createDynamic(Property<?> prop, boolean isConfig)
static EventProperty	createStatic(Property<?> prop, boolean isConfig)
boolean	equals(java.lang.Object obj)
java.lang.Object	getDefaultValue() The default value for new instances of this property, or null if not applicable.
java.lang.String	getName() The "name" of this property.
EventPropertyType	getPropertyType()
java.lang.Class	getType() The data type for this property.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

internal

protected Property<?> internal

type

protected EventPropertyType type

Constructor Detail

EventProperty

public EventProperty(Property<?> prop,
                     EventPropertyType type)

Method Detail

getName

public java.lang.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

getType

public java.lang.Class getType()

Description copied from interface: Property

The data type for this property.

Specified by:

getType in interface Property

getDefaultValue

public java.lang.Object getDefaultValue()

Description copied from interface: Property

The default value for new instances of this property, or null if not applicable.

Specified by:

getDefaultValue in interface Property

getPropertyType

public EventPropertyType getPropertyType()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

createStatic

public static EventProperty createStatic(Property<?> prop,
                                         boolean isConfig)

createDynamic

public static EventProperty createDynamic(Property<?> prop,
                                          boolean isConfig)