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

Enum Class AgeRestriction

java.lang.Object

java.lang.Enum<AgeRestriction>

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

All Implemented Interfaces:

Localized, Serializable, Comparable<AgeRestriction>, Constable

public enum AgeRestriction
extends Enum<AgeRestriction>
implements Localized

Describes how the age of something (such as a historical tag value) is handled.

This enum has been modified to include time based capping (it was originally just unlimited, or "capped" - based on execution count).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Capped	This value means "capped, X executions"
Capped_Day
Capped_Hour
Capped_Min
Capped_MS
Capped_Sec
Unlimited

Method Summary

Modifier and Type	Method	Description
static AgeRestriction[]	cappedValues()
TimeUnits	getAsTimeUnits()	Returns the TimeUnits for the value, if the value is a time restriction.
int	getIntValue()	Returns the integer representation of this enum
static AgeRestriction	getTypeForValue(int val)	Returns the AgeRestriction for the given type code.
boolean	isTimeRestriction()
String	toString(Locale locale)
static AgeRestriction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AgeRestriction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Unlimited

public static final AgeRestriction Unlimited

Capped

public static final AgeRestriction Capped

This value means "capped, X executions"

Capped_MS

public static final AgeRestriction Capped_MS

Capped_Sec

public static final AgeRestriction Capped_Sec

Capped_Min

public static final AgeRestriction Capped_Min

Capped_Hour

public static final AgeRestriction Capped_Hour

Capped_Day

public static final AgeRestriction Capped_Day

Method Details

values

public static AgeRestriction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AgeRestriction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getIntValue

public int getIntValue()

Returns the integer representation of this enum

isTimeRestriction

public boolean isTimeRestriction()

getAsTimeUnits

public TimeUnits getAsTimeUnits()

Returns the TimeUnits for the value, if the value is a time restriction. Otherwise, returns null.

getTypeForValue

public static AgeRestriction getTypeForValue(int val)

Returns the AgeRestriction for the given type code. Returns Unlimited if there is no value defined mode for the given value.

cappedValues

public static AgeRestriction[] cappedValues()

toString

public String toString(Locale locale)

Specified by:

toString in interface Localized