Package com.inductiveautomation.ignition.common.tags.config.properties

Class WellKnownTagProps

java.lang.Object

com.inductiveautomation.ignition.common.tags.config.properties.WellKnownTagProps

Direct Known Subclasses:

DBTagTypeProperties, ExpressionTypeProperties, OpcTagTypeProperties, ReferenceTagTypeProps

public class WellKnownTagProps
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Property<AccessRightsType>	AccessRights	Deprecated.
static final Property<Boolean>	AlarmEvalEnabled
static final Property<AlarmConfiguration>	Alarms
static final Property<?>[]	BASIC_PROPERTIES
static final String	CAT_ALARMS
static final String	CAT_BASIC
static final String	CAT_META
static final String	CAT_NUM
static final String	CAT_PARAMETERS
static final String	CAT_SCRIPT
static final String	CAT_SECURITY
static final String	CAT_VALUE
static final Property<ClampMode>	ClampMode
static final Property<DataType>	DataType
static final Property<Double>	Deadband
static final Property<DeadbandMode>	DeadbandMode
static final Property<String>	Documentation
static final Property<Boolean>	Enabled
static final Property<Double>	EngHigh
static final Property<ClampMode>	EngLimitMode
static final Property<Double>	EngLow
static final Property<String>	EngUnit
static final Property<TagEventScripts>	EventScripts
static final Property<TagExecutionMode>	ExecutionMode
static final Property<Long>	ExecutionRate
static final Property<String>	FormatString
static final Property<Boolean>	HistoryEnabled
static final Property<String>	HistoryProvider
static final String	MEMORY_TAG_TYPE
static final Property<String>	Name
static final Property<BoundPropertySet>	Parameters	Parameters are values that are defined on UDT Definitions that can be referenced by properties inside of members.
static final Property<TagPath>	Path
static final Property<TagPermissionsModel>	PermissionModel	Deprecated.
static final Property<Boolean>	PersistValue
static final Property<BoundPropertySet>	PRG_CFG	These are not config properties, they are special properties used by managed providers.
static final Property<QualityCode>	Quality
static final Property<Double>	RawHigh
static final Property<Double>	RawLow
static final Property<Boolean>	ReadOnly
static final Property<PermissionsConfig>	ReadPermissions
static final String	RESOURCE_TAG_GROUPS	For resource based values in the property model.
static final Property<Double>	ScaledHigh
static final Property<Double>	ScaledLow
static final Property<Double>	ScaleFactor	Scale factor is for exponential filter mode.
static final Property<ScaleMode>	ScaleMode
static final Property<String>	TagGroup
static final Property<TagObjectType>	TagType
static final Property<Date>	Timestamp
static final Property<String>	Tooltip
static final Property<Integer>	TypeColor
static final Property<String>	TypeId	If the tag type id is udt_def or udt_inst, typeId is the parent data type.
static final Property<BoundPropertySet>	USR_CFG
static final Property<QualifiedValue>	Value
static final Property<String>	ValueSource	The id of the value generator for the tag.
static final Property<PermissionsConfig>	WritePermissions

Constructor Summary

Constructors

Constructor	Description
WellKnownTagProps()

Method Summary

Modifier and Type	Method	Description
static String	categoryKey(String category)
protected static <T> ConfigurationProperty<T>	cfg(String name, Class<T> clazz, T defaultVal, String category, String editorClass)
protected static <T> DescriptiveProperty<T>	desc(String name, Class<T> clazz, T defaultVal, String category)
static String	descriptionKey(String property)
static String	propertyKey(String property)
static void	register(MutableConfigurationPropertyModel model)
protected static void	registerAtomic(MutableConfigurationPropertyModel model, Property<?>... props)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MEMORY_TAG_TYPE

public static final String MEMORY_TAG_TYPE

See Also:

• Constant Field Values

CAT_BASIC

public static final String CAT_BASIC

See Also:

• Constant Field Values

CAT_PARAMETERS

public static final String CAT_PARAMETERS

See Also:

• Constant Field Values

CAT_VALUE

public static final String CAT_VALUE

See Also:

• Constant Field Values

CAT_META

public static final String CAT_META

See Also:

• Constant Field Values

CAT_SECURITY

public static final String CAT_SECURITY

See Also:

• Constant Field Values

CAT_NUM

public static final String CAT_NUM

See Also:

• Constant Field Values

CAT_SCRIPT

public static final String CAT_SCRIPT

See Also:

• Constant Field Values

CAT_ALARMS

public static final String CAT_ALARMS

See Also:

• Constant Field Values

RESOURCE_TAG_GROUPS

public static final String RESOURCE_TAG_GROUPS

For resource based values in the property model.

See Also:

• Constant Field Values

Name

public static final Property<String> Name

Enabled

public static final Property<Boolean> Enabled

TagGroup

public static final Property<String> TagGroup

Documentation

public static final Property<String> Documentation

TagType

public static final Property<TagObjectType> TagType

Path

public static final Property<TagPath> Path

TypeId

public static final Property<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<Date> Timestamp

ValueSource

public static final Property<String> ValueSource

The id of the value generator for the tag. For example, "memory", "opc", "expression", etc.

DataType

public static final Property<DataType> DataType

PersistValue

public static final Property<Boolean> PersistValue

ExecutionMode

public static final Property<TagExecutionMode> ExecutionMode

ExecutionRate

public static final Property<Long> ExecutionRate

FormatString

public static final Property<String> FormatString

Deadband

public static final Property<Double> Deadband

DeadbandMode

public static final Property<DeadbandMode> DeadbandMode

ScaleMode

public static final Property<ScaleMode> ScaleMode

RawLow

public static final Property<Double> RawLow

RawHigh

public static final Property<Double> RawHigh

ScaledLow

public static final Property<Double> ScaledLow

ScaledHigh

public static final Property<Double> ScaledHigh

ClampMode

public static final Property<ClampMode> ClampMode

ScaleFactor

public static final Property<Double> ScaleFactor

Scale factor is for exponential filter mode.

EngUnit

public static final Property<String> EngUnit

EngLow

public static final Property<Double> EngLow

EngHigh

public static final Property<Double> EngHigh

EngLimitMode

public static final Property<ClampMode> EngLimitMode

Tooltip

public static final Property<String> Tooltip

TypeColor

public static final Property<Integer> TypeColor

EventScripts

public static final Property<TagEventScripts> EventScripts

AccessRights

@Deprecated(since="8.0.8")
public static final Property<AccessRightsType> AccessRights

Deprecated.

AccessRights and PermissionModel props are deprecated in favor of the new Tag Permissions Model. These props are left here for upgrade purposes only. Use ReadPermissions, ReadOnly, and WritePermissions 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. Use ReadPermissions, ReadOnly, and WritePermissions going forward.

ReadPermissions

public static final Property<PermissionsConfig> ReadPermissions

ReadOnly

public static final Property<Boolean> ReadOnly

WritePermissions

public static final Property<PermissionsConfig> WritePermissions

HistoryEnabled

public static final Property<Boolean> HistoryEnabled

HistoryProvider

public static final Property<String> HistoryProvider

Alarms

public static final Property<AlarmConfiguration> Alarms

AlarmEvalEnabled

public static final Property<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

Constructor Details

WellKnownTagProps

public WellKnownTagProps()

Method Details

propertyKey

public static String propertyKey(String property)

categoryKey

public static String categoryKey(String category)

descriptionKey

public static String descriptionKey(String property)

desc

protected static <T> DescriptiveProperty<T> desc(String name,
 Class<T> clazz,
 T defaultVal,
 String category)

cfg

protected static <T> ConfigurationProperty<T> cfg(String name,
 Class<T> clazz,
 T defaultVal,
 String category,
 String editorClass)

registerAtomic

protected static void registerAtomic(MutableConfigurationPropertyModel model,
 Property<?>... props)

register

public static void register(MutableConfigurationPropertyModel model)