com.inductiveautomation.gateway.tsdb.impl

Class BasicPathInfo

java.lang.Object

com.inductiveautomation.gateway.tsdb.impl.BasicPathInfo

All Implemented Interfaces:

PathInfo

public class BasicPathInfo
extends java.lang.Object
implements PathInfo

Created by colby.clegg on 3/15/2016.

Constructor Summary

Constructors

Constructor and Description
BasicPathInfo(int index, java.lang.String path, DataType dataType)
BasicPathInfo(int index, java.lang.String path, DataType dataType, InterpolationMode interpolation, PropertySet properties)

Method Summary

Modifier and Type	Method and Description
DataType	getDataType() The data type of the item in the result set.
InterpolationMode	getInterpolationMode() How the tag thinks it should be interpolated.
java.lang.String	getPath() The string path representing the specific tag/datapoint.
PropertySet	getProperties() Includes any extra properties about the tag that were stored.
int	index() An id that is unique for this path in this query result set.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicPathInfo

public BasicPathInfo(int index,
                     java.lang.String path,
                     DataType dataType)

BasicPathInfo

public BasicPathInfo(int index,
                     java.lang.String path,
                     DataType dataType,
                     InterpolationMode interpolation,
                     PropertySet properties)

Method Detail

index

public int index()

Description copied from interface: PathInfo

An id that is unique for this path in this query result set. It is a shortcut for the path reference, useful for hashing and bookkeeping. It refers to the position of the path in the query path list.

Specified by:

index in interface PathInfo

getPath

public java.lang.String getPath()

Description copied from interface: PathInfo

The string path representing the specific tag/datapoint.

Specified by:

getPath in interface PathInfo

getDataType

public DataType getDataType()

Description copied from interface: PathInfo

The data type of the item in the result set.

Specified by:

getDataType in interface PathInfo

getInterpolationMode

public InterpolationMode getInterpolationMode()

Description copied from interface: PathInfo

How the tag thinks it should be interpolated.

Specified by:

getInterpolationMode in interface PathInfo

getProperties

public PropertySet getProperties()

Description copied from interface: PathInfo

Includes any extra properties about the tag that were stored.

Specified by:

getProperties in interface PathInfo