Package com.inductiveautomation.ignition.gateway.sqltags.model.tagstore

Class BasicTagPropertyValue

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.model.tagstore.TagStoreObject<QualifiedValue>

com.inductiveautomation.ignition.gateway.sqltags.model.tagstore.BasicTagPropertyValue

All Implemented Interfaces:

TagPropertyValue, java.io.Serializable

public class BasicTagPropertyValue
extends TagStoreObject<QualifiedValue>
implements java.io.Serializable, TagPropertyValue

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.sqltags.model.tagstore.TagPropertyValue

TagPropertyValue.HashKey

Field Summary

Fields

Modifier and Type	Field	Description
static int	HINT_CONFIGPROP	Hint indicating that this is a core property that will require a tag reload
static int	HINT_PERSISTENT	Hint that the value should be stored and loaded on startup

Constructor Summary

Constructors

Constructor	Description
BasicTagPropertyValue()
BasicTagPropertyValue(EntityId id, QualifiedValue value, TagProp property)	Constructor for storing an arbitrary property - DO NOT USE for Tag's Value! Use other constructor instead, in order to set the correct data type.
BasicTagPropertyValue(EntityId id, QualifiedValue value, DataTypeClass dType, int... hints)	Constructor for storing the tag's "Value" property
BasicTagPropertyValue(TagPropertyValue copy)

Method Summary

Modifier and Type	Method	Description
DataTypeClass	getDataTypeClass()
protected int	getHints()
TagProp	getProperty()
QualifiedValue	getValue()
boolean	hasHint(int hint)	Indicates whether the value has the hint specified.
boolean	hasHintConfig()
boolean	hasHintPersistent()
protected void	setDataTypeClass(DataTypeClass value)
void	setHint(int hint, boolean on)	Sets or unsets the specified hint.
protected void	setHints(int value)
protected void	setProperty(TagProp value)
java.lang.String	toString()

Methods inherited from class com.inductiveautomation.ignition.gateway.sqltags.model.tagstore.TagStoreObject

getEntity, getId, setEntity, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.sqltags.model.tagstore.TagPropertyValue

getId

Field Detail

HINT_PERSISTENT

public static final int HINT_PERSISTENT

Hint that the value should be stored and loaded on startup

See Also:

Constant Field Values

HINT_CONFIGPROP

public static final int HINT_CONFIGPROP

Hint indicating that this is a core property that will require a tag reload

See Also:

Constant Field Values

Constructor Detail

BasicTagPropertyValue

public BasicTagPropertyValue(EntityId id,
                             QualifiedValue value,
                             DataTypeClass dType,
                             int... hints)

Constructor for storing the tag's "Value" property

BasicTagPropertyValue

public BasicTagPropertyValue(TagPropertyValue copy)

BasicTagPropertyValue

public BasicTagPropertyValue()

BasicTagPropertyValue

public BasicTagPropertyValue(EntityId id,
                             QualifiedValue value,
                             TagProp property)

Constructor for storing an arbitrary property - DO NOT USE for Tag's Value! Use other constructor instead, in order to set the correct data type.

Method Detail

getDataTypeClass

public DataTypeClass getDataTypeClass()

Specified by:

getDataTypeClass in interface TagPropertyValue

setDataTypeClass

protected void setDataTypeClass(DataTypeClass value)

getProperty

public TagProp getProperty()

Specified by:

getProperty in interface TagPropertyValue

setProperty

protected void setProperty(TagProp value)

getHints

protected int getHints()

setHints

protected void setHints(int value)

hasHint

public boolean hasHint(int hint)

Indicates whether the value has the hint specified. Hint values are static members of the TagStoreValue class.

setHint

public void setHint(int hint,
                    boolean on)

Sets or unsets the specified hint. See hasHint for more information on hints.

getValue

public QualifiedValue getValue()

Specified by:

getValue in interface TagPropertyValue

hasHintConfig

public boolean hasHintConfig()

Specified by:

hasHintConfig in interface TagPropertyValue

hasHintPersistent

public boolean hasHintPersistent()

Specified by:

hasHintPersistent in interface TagPropertyValue

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object