Package com.inductiveautomation.ignition.common.sqltags.history

Class TagHistoryQueryFlags

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.history.TagHistoryQueryFlags

public class TagHistoryQueryFlags
extends Object

This class defines static values that can be set on the flags field of TagHistoryQueryParams in order to change the behavior of the query.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOUNDING_VALUES_NO
static final int	BOUNDING_VALUES_YES	Indicates whether bounding values should specifically be included or excluded.
static final int	IGNORE_BAD_QUALITY	Ignore any data that has bad quality.
static final int	NO_CACHE	Do not uses values from any cache.
static final int	NO_INTERPOLATION	Do not interpolate values
static final int	NO_PREPROCESSED_DATA	Requests that we only query raw data.
static final int	NO_SCANCLASS_VALIDATION	Do not validate scan class executions
static final int	NO_SEED_VALUES	Do not read seed values for the query.

Constructor Summary

Constructors

Constructor	Description
TagHistoryQueryFlags()

Method Summary

Modifier and Type	Method	Description
static boolean	readSeedValues(TagHistoryQueryParams queryParams)	Helper function for determining if seed values should be used, based on flags for bounding values and other settings.
static String	toDescriptiveString(Flags value)	Prints out readable names for the values of flags, comma separated.

Methods inherited from class java.lang.Object

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

Field Details

NO_SEED_VALUES

public static final int NO_SEED_VALUES

Do not read seed values for the query.

See Also:

• Constant Field Values

NO_CACHE

public static final int NO_CACHE

Do not uses values from any cache.

See Also:

• Constant Field Values

NO_SCANCLASS_VALIDATION

public static final int NO_SCANCLASS_VALIDATION

Do not validate scan class executions

See Also:

• Constant Field Values

NO_INTERPOLATION

public static final int NO_INTERPOLATION

Do not interpolate values

See Also:

• Constant Field Values

BOUNDING_VALUES_YES

public static final int BOUNDING_VALUES_YES

Indicates whether bounding values should specifically be included or excluded. This flag set has 2 values because the default is different based on the mode (off for raw, on for sampled). If neither flag is specified, we use the default.

See Also:

• Constant Field Values

BOUNDING_VALUES_NO

public static final int BOUNDING_VALUES_NO

See Also:

• Constant Field Values

IGNORE_BAD_QUALITY

public static final int IGNORE_BAD_QUALITY

Ignore any data that has bad quality.

See Also:

• Constant Field Values

NO_PREPROCESSED_DATA

public static final int NO_PREPROCESSED_DATA

Requests that we only query raw data.

See Also:

• Constant Field Values

Constructor Details

TagHistoryQueryFlags

public TagHistoryQueryFlags()

Method Details

readSeedValues

public static boolean readSeedValues(TagHistoryQueryParams queryParams)

Helper function for determining if seed values should be used, based on flags for bounding values and other settings.

toDescriptiveString

public static String toDescriptiveString(Flags value)

Prints out readable names for the values of flags, comma separated. If no flags are set, "NONE" is returned.