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

Class RealtimeTagHistoryQueryParams

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams

com.inductiveautomation.ignition.common.sqltags.history.RealtimeTagHistoryQueryParams

All Implemented Interfaces:

TagHistoryQueryParams, java.io.Serializable

public class RealtimeTagHistoryQueryParams
extends BasicTagHistoryQueryParams

Tag history query param implementation that dynamically returns start and end dates based on the current time.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RealtimeTagHistoryQueryParams(java.util.List<? extends Path> paths, int rangeLength, TimeUnits rangeUnits, int returnSize, Aggregate aggregationMode, ReturnFormat returnFormat, java.util.List<java.lang.String> aliases, java.util.List<Aggregate> colAggModes)
RealtimeTagHistoryQueryParams(java.util.List<? extends Path> paths, int rangeLength, TimeUnits rangeUnits, int intervalLength, TimeUnits intervalUnits, Aggregate aggregationMode, ReturnFormat returnFormat, java.util.List<java.lang.String> aliases, java.util.List<Aggregate> colAggModes)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getEndDate()	The ending range of the query.
int	getReturnSize()	How many results are desired.
java.util.Date	getStartDate()	The starting range of the query.

Methods inherited from class com.inductiveautomation.ignition.common.sqltags.history.BasicTagHistoryQueryParams

getAggregationMode, getAliases, getColumnAggregationModes, getPaths, getQueryFlags, getReturnFormat, setAggregationMode, setAliases, setColumnAggregationModes, setEndDate, setPaths, setQueryFlags, setReturnFormat, setReturnSize, setStartDate, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RealtimeTagHistoryQueryParams

public RealtimeTagHistoryQueryParams(java.util.List<? extends Path> paths,
                                     int rangeLength,
                                     TimeUnits rangeUnits,
                                     int returnSize,
                                     Aggregate aggregationMode,
                                     ReturnFormat returnFormat,
                                     java.util.List<java.lang.String> aliases,
                                     java.util.List<Aggregate> colAggModes)

RealtimeTagHistoryQueryParams

public RealtimeTagHistoryQueryParams(java.util.List<? extends Path> paths,
                                     int rangeLength,
                                     TimeUnits rangeUnits,
                                     int intervalLength,
                                     TimeUnits intervalUnits,
                                     Aggregate aggregationMode,
                                     ReturnFormat returnFormat,
                                     java.util.List<java.lang.String> aliases,
                                     java.util.List<Aggregate> colAggModes)

Method Detail

getStartDate

public java.util.Date getStartDate()

Description copied from interface: TagHistoryQueryParams

The starting range of the query.

Specified by:

getStartDate in interface TagHistoryQueryParams

Overrides:

getStartDate in class BasicTagHistoryQueryParams

getEndDate

public java.util.Date getEndDate()

Description copied from interface: TagHistoryQueryParams

The ending range of the query. If null, the query will be considered "realtime", and will cover up to the current time.

Specified by:

getEndDate in interface TagHistoryQueryParams

Overrides:

getEndDate in class BasicTagHistoryQueryParams

getReturnSize

public int getReturnSize()

Description copied from interface: TagHistoryQueryParams

How many results are desired. -1 means "raw", 0 means "natural", and positive numbers are fixed rows. The definitions of "-1" and "0" may vary according to provider.

Specified by:

getReturnSize in interface TagHistoryQueryParams

Overrides:

getReturnSize in class BasicTagHistoryQueryParams