Class WellKnownTagProps
- java.lang.Object
-
- com.inductiveautomation.ignition.common.tags.config.properties.WellKnownTagProps
-
- Direct Known Subclasses:
DBTagTypeProperties
,ExpressionTypeProperties
,OpcTagTypeProperties
,ReferenceTagTypeProps
public class WellKnownTagProps extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static Property<AccessRightsType>
AccessRights
Deprecated.static Property<java.lang.Boolean>
AlarmEvalEnabled
static Property<AlarmConfiguration>
Alarms
static Property<?>[]
BASIC_PROPERTIES
static java.lang.String
CAT_ALARMS
static java.lang.String
CAT_BASIC
static java.lang.String
CAT_META
static java.lang.String
CAT_NUM
static java.lang.String
CAT_SCRIPT
static java.lang.String
CAT_SECURITY
static java.lang.String
CAT_VALUE
static Property<ClampMode>
ClampMode
static Property<DataType>
DataType
static Property<java.lang.Double>
Deadband
static Property<DeadbandMode>
DeadbandMode
static Property<java.lang.String>
Documentation
static Property<java.lang.Boolean>
Enabled
static Property<java.lang.Double>
EngHigh
static Property<ClampMode>
EngLimitMode
static Property<java.lang.Double>
EngLow
static Property<java.lang.String>
EngUnit
static Property<TagEventScripts>
EventScripts
static Property<TagExecutionMode>
ExecutionMode
static Property<java.lang.Long>
ExecutionRate
static Property<java.lang.String>
FormatString
static Property<java.lang.Boolean>
HistoryEnabled
static Property<java.lang.String>
HistoryProvider
static java.lang.String
MEMORY_TAG_TYPE
static Property<java.lang.String>
Name
static Property<BoundPropertySet>
Parameters
Parameters are values that are defined on UDT Definitions that can be referenced by properties inside of members.static Property<TagPath>
Path
static Property<TagPermissionsModel>
PermissionModel
Deprecated.static Property<java.lang.Boolean>
PersistValue
static Property<BoundPropertySet>
PRG_CFG
These are not config properties, they are special properties used by managed providers.static Property<QualityCode>
Quality
static Property<java.lang.Double>
RawHigh
static Property<java.lang.Double>
RawLow
static Property<java.lang.Boolean>
ReadOnly
static Property<PermissionsConfig>
ReadPermissions
static java.lang.String
RESOURCE_TAG_GROUPS
For resource based values in the property model.static Property<java.lang.Double>
ScaledHigh
static Property<java.lang.Double>
ScaledLow
static Property<java.lang.Double>
ScaleFactor
Scale factor is for exponential filter mode.static Property<ScaleMode>
ScaleMode
static Property<java.lang.String>
TagGroup
static Property<TagObjectType>
TagType
static Property<java.util.Date>
Timestamp
static Property<java.lang.String>
Tooltip
static Property<java.lang.Integer>
TypeColor
static Property<java.lang.String>
TypeId
If the tag type id is udt_def or udt_inst, typeId is the parent data type.static Property<BoundPropertySet>
USR_CFG
static Property<QualifiedValue>
Value
static Property<java.lang.String>
ValueSource
The id of the value generator for the tag.static Property<PermissionsConfig>
WritePermissions
-
Constructor Summary
Constructors Constructor Description WellKnownTagProps()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
categoryKey(java.lang.String category)
protected static <T> ConfigurationProperty<T>
cfg(java.lang.String name, java.lang.Class<T> clazz, T defaultVal, java.lang.String category, java.lang.String editorClass)
protected static <T> DescriptiveProperty<T>
desc(java.lang.String name, java.lang.Class<T> clazz, T defaultVal, java.lang.String category)
static java.lang.String
propertyKey(java.lang.String property)
static void
register(MutableConfigurationPropertyModel model)
protected static void
registerAtomic(MutableConfigurationPropertyModel model, Property<?>... props)
-
-
-
Field Detail
-
MEMORY_TAG_TYPE
public static final java.lang.String MEMORY_TAG_TYPE
- See Also:
- Constant Field Values
-
CAT_BASIC
public static final java.lang.String CAT_BASIC
- See Also:
- Constant Field Values
-
CAT_VALUE
public static final java.lang.String CAT_VALUE
- See Also:
- Constant Field Values
-
CAT_META
public static final java.lang.String CAT_META
- See Also:
- Constant Field Values
-
CAT_SECURITY
public static final java.lang.String CAT_SECURITY
- See Also:
- Constant Field Values
-
CAT_NUM
public static final java.lang.String CAT_NUM
- See Also:
- Constant Field Values
-
CAT_SCRIPT
public static final java.lang.String CAT_SCRIPT
- See Also:
- Constant Field Values
-
CAT_ALARMS
public static final java.lang.String CAT_ALARMS
- See Also:
- Constant Field Values
-
RESOURCE_TAG_GROUPS
public static final java.lang.String RESOURCE_TAG_GROUPS
For resource based values in the property model.- See Also:
- Constant Field Values
-
Name
public static final Property<java.lang.String> Name
-
Enabled
public static final Property<java.lang.Boolean> Enabled
-
TagGroup
public static final Property<java.lang.String> TagGroup
-
Documentation
public static final Property<java.lang.String> Documentation
-
TagType
public static final Property<TagObjectType> TagType
-
TypeId
public static final Property<java.lang.String> TypeId
If the tag type id is udt_def or udt_inst, typeId is the parent data type.
-
Value
public static final Property<QualifiedValue> Value
-
Quality
public static final Property<QualityCode> Quality
-
Timestamp
public static final Property<java.util.Date> Timestamp
-
ValueSource
public static final Property<java.lang.String> ValueSource
The id of the value generator for the tag. For example, "memory", "opc", "expression", etc.
-
PersistValue
public static final Property<java.lang.Boolean> PersistValue
-
ExecutionMode
public static final Property<TagExecutionMode> ExecutionMode
-
ExecutionRate
public static final Property<java.lang.Long> ExecutionRate
-
FormatString
public static final Property<java.lang.String> FormatString
-
Deadband
public static final Property<java.lang.Double> Deadband
-
DeadbandMode
public static final Property<DeadbandMode> DeadbandMode
-
RawLow
public static final Property<java.lang.Double> RawLow
-
RawHigh
public static final Property<java.lang.Double> RawHigh
-
ScaledLow
public static final Property<java.lang.Double> ScaledLow
-
ScaledHigh
public static final Property<java.lang.Double> ScaledHigh
-
ScaleFactor
public static final Property<java.lang.Double> ScaleFactor
Scale factor is for exponential filter mode.
-
EngUnit
public static final Property<java.lang.String> EngUnit
-
EngLow
public static final Property<java.lang.Double> EngLow
-
EngHigh
public static final Property<java.lang.Double> EngHigh
-
Tooltip
public static final Property<java.lang.String> Tooltip
-
TypeColor
public static final Property<java.lang.Integer> TypeColor
-
EventScripts
public static final Property<TagEventScripts> EventScripts
-
AccessRights
@Deprecated(since="8.0.8") public static final Property<AccessRightsType> AccessRights
Deprecated.AccessRights andPermissionModel
props are deprecated in favor of the new Tag Permissions Model. These props are left here for upgrade purposes only. UseReadPermissions
,ReadOnly
, andWritePermissions
going forward.
-
PermissionModel
@Deprecated(since="8.0.8") public static final Property<TagPermissionsModel> PermissionModel
Deprecated.AccessRights
and PermissionModel props are deprecated in favor of the new Tag Permissions Model. These props are left here for upgrade purposes only. UseReadPermissions
,ReadOnly
, andWritePermissions
going forward.
-
ReadPermissions
public static final Property<PermissionsConfig> ReadPermissions
-
ReadOnly
public static final Property<java.lang.Boolean> ReadOnly
-
WritePermissions
public static final Property<PermissionsConfig> WritePermissions
-
HistoryEnabled
public static final Property<java.lang.Boolean> HistoryEnabled
-
HistoryProvider
public static final Property<java.lang.String> HistoryProvider
-
Alarms
public static final Property<AlarmConfiguration> Alarms
-
AlarmEvalEnabled
public static final Property<java.lang.Boolean> AlarmEvalEnabled
-
Parameters
public static final Property<BoundPropertySet> Parameters
Parameters are values that are defined on UDT Definitions that can be referenced by properties inside of members.
-
PRG_CFG
public static final Property<BoundPropertySet> PRG_CFG
These are not config properties, they are special properties used by managed providers.
-
USR_CFG
public static final Property<BoundPropertySet> USR_CFG
-
BASIC_PROPERTIES
public static final Property<?>[] BASIC_PROPERTIES
-
-
Method Detail
-
propertyKey
public static final java.lang.String propertyKey(java.lang.String property)
-
categoryKey
public static final java.lang.String categoryKey(java.lang.String category)
-
desc
protected static <T> DescriptiveProperty<T> desc(java.lang.String name, java.lang.Class<T> clazz, T defaultVal, java.lang.String category)
-
cfg
protected static <T> ConfigurationProperty<T> cfg(java.lang.String name, java.lang.Class<T> clazz, T defaultVal, java.lang.String category, java.lang.String editorClass)
-
registerAtomic
protected static void registerAtomic(MutableConfigurationPropertyModel model, Property<?>... props)
-
register
public static void register(MutableConfigurationPropertyModel model)
-
-