Package com.inductiveautomation.ignition.common.sqltags.model.types

Enum TagType

java.lang.Object

java.lang.Enum<TagType>

com.inductiveautomation.ignition.common.sqltags.model.types.TagType

All Implemented Interfaces:

ExtendedTagType, java.io.Serializable, java.lang.Comparable<TagType>

public enum TagType
extends java.lang.Enum<TagType>
implements ExtendedTagType

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTRIBUTE
Client
Custom
DB
DERIVED
EXTENSION
External
Folder
FPMIClient
FPMIGateway
FSQLSystem
OPC
UDT_DEF
UDT_INST

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.util.Set<TagProp>	CLIENT_DATE_PROPERTIES
protected static java.util.Set<TagProp>	CLIENT_PROPERTIES
protected static java.util.Set<TagProp>	DATE_PROPERTIES
protected static java.util.Set<TagProp>	DB_DEFAULT_PROPS
protected static java.util.Set<TagProp>	DEFAULT_PROPERTIES
protected static java.util.Set<TagProp>	DERIVED_DEFAULT_PROPS
protected static java.util.Set<TagProp>	NUMERIC_PROPERTIES
protected static java.util.Set<TagProp>	OPC_DEFAULT_PROPS

Method Summary

Modifier and Type	Method	Description
static TagType	fromTagObjectType(TagObjectType objectType)
java.util.Set<TagProp>	getBindableProperties(Tag tag)
TagType	getCoreType()
TagMeta	getDefaultMeta()
int	getIntValue()	Returns the integer value for this tag type
java.lang.String	getSubType()	Sub-type is a code relevant to the provider to allow it to distinguish between different variations of tags defined inside the broad type categories.
static TagType	getTypeForValue(int val)	Returns the TagType for the given int value.
java.lang.String	getUUID()
boolean	hasSubTags()
boolean	isComplex()
boolean	supportsAlarming()
TagObjectType	toTagObjectType()
static TagType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TagType	valueOfCaseInsensitive(java.lang.String name)	Returns the type for the given name, ignoring case.
static TagType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPC

public static final TagType OPC

DB

public static final TagType DB

Client

public static final TagType Client

FSQLSystem

public static final TagType FSQLSystem

FPMIGateway

public static final TagType FPMIGateway

FPMIClient

public static final TagType FPMIClient

Folder

public static final TagType Folder

External

public static final TagType External

Custom

public static final TagType Custom

UDT_DEF

public static final TagType UDT_DEF

UDT_INST

public static final TagType UDT_INST

ATTRIBUTE

public static final TagType ATTRIBUTE

EXTENSION

public static final TagType EXTENSION

DERIVED

public static final TagType DERIVED

Field Detail

NUMERIC_PROPERTIES

protected static final java.util.Set<TagProp> NUMERIC_PROPERTIES

DATE_PROPERTIES

protected static final java.util.Set<TagProp> DATE_PROPERTIES

DEFAULT_PROPERTIES

protected static final java.util.Set<TagProp> DEFAULT_PROPERTIES

CLIENT_PROPERTIES

protected static final java.util.Set<TagProp> CLIENT_PROPERTIES

CLIENT_DATE_PROPERTIES

protected static final java.util.Set<TagProp> CLIENT_DATE_PROPERTIES

OPC_DEFAULT_PROPS

protected static final java.util.Set<TagProp> OPC_DEFAULT_PROPS

DB_DEFAULT_PROPS

protected static final java.util.Set<TagProp> DB_DEFAULT_PROPS

DERIVED_DEFAULT_PROPS

protected static final java.util.Set<TagProp> DERIVED_DEFAULT_PROPS

Method Detail

values

public static TagType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TagType c : TagType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TagType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

valueOfCaseInsensitive

public static TagType valueOfCaseInsensitive(java.lang.String name)
                                      throws java.lang.IllegalArgumentException

Returns the type for the given name, ignoring case. If type doesn't exist, illegalargumentexception will be thrown.

Throws:

java.lang.IllegalArgumentException

getIntValue

public int getIntValue()

Returns the integer value for this tag type

getCoreType

public TagType getCoreType()

Specified by:

getCoreType in interface ExtendedTagType

getSubType

public java.lang.String getSubType()

Description copied from interface: ExtendedTagType

Sub-type is a code relevant to the provider to allow it to distinguish between different variations of tags defined inside the broad type categories.

Specified by:

getSubType in interface ExtendedTagType

getDefaultMeta

public TagMeta getDefaultMeta()

hasSubTags

public boolean hasSubTags()

isComplex

public boolean isComplex()

getUUID

public java.lang.String getUUID()

toTagObjectType

public TagObjectType toTagObjectType()

fromTagObjectType

public static TagType fromTagObjectType(TagObjectType objectType)

getTypeForValue

public static TagType getTypeForValue(int val)

Returns the TagType for the given int value. If there is no tag type for that value, null is returned.

getBindableProperties

public java.util.Set<TagProp> getBindableProperties(Tag tag)

supportsAlarming

public boolean supportsAlarming()