Classes
class	DataSeriesClient
	Provides methods for reading data. More...
interface	IDataPoint
	Represents a single data point with timestamp, quality, and value(s). More...

Enumerations
enum	AggregateType
	Specifies the types of aggregation that can be applied to tag data.
enum	DigitalTextReturnType
	Specifies how digital text values should be returned.
enum	InterpolationType
	Describes the interpolation method to apply to time-series data.
enum	ReadRawError
	Represents the error types returned when reading raw data.
enum	ReadSourceInfoError
	Represents the error types returned when reading source info.
enum	RunNormalizationMode
	Describes the normalization mode used during run-based aggregations.
enum	TagDataType
	Describes the data type of a tag.

Functions
readonly record struct	BulkAggExportResult (DateTime[] Timestamps, DataPointSet[] Values, int TotalStreamChunkNumber, int CurrentChunkNumber)
	Represents a result chunk from aggregate data export.
readonly record struct	BulkExportResult (DateTime[] Timestamps, DataPointList[] Values, int TotalStreamChunkNumber, int CurrentChunkNumber)
	Represents a result chunk from raw data export.
readonly record struct	BulkExportWithInterpolationParameters (ExportParameters[] ExportParameters, DateTime StartTime, DateTime EndTime, int StepSize, AggregateType? AggregateType, long MaximumExportSize, RunNormalizationMode? RunNormalizationMode, bool IsInterpolateStateTag, bool IncludeBounds=true)
	Parameters for reading data points by aggregate type for a collection of tags.
readonly record struct	BulkExportWithoutInterpolationParameters (ExportParameters[] ExportParameters, DateTime StartTime, DateTime EndTime, long MaximumExportSize, bool IncludeBounds=true)
	Parameters for exporting raw data points without interpolation for a collection of tags.
readonly record struct DataPointDouble(DateTime Timestamp, int Quality, double[] Values) readonly record struct DataPointDigitalText(DateTime Timestamp, int Quality, DigitalText[] Values) readonly record struct	DataPointSet (TagIdentifier Tag, DataPoints DataPoints)
	Represents a numeric data point with double array values.
readonly record struct	ExportParameters (string Tag, int DeltaTime, InterpolationType? InterpolationType, bool ForceQualityCheck)
	Parameters for exporting a tag data.
readonly record struct	FullyQualifiedTagName (string InterfaceGroup, string Tag, string? Interface=null, string? InterfaceSet=null)
	Fully identifies a tag by group, name, interface, and set.
readonly record struct	LatestQuickStatisticsParameters (TagLatestQuickStatisticsParameters[] TagParams, AggregateType?[] Aggregates)
	Parameters for retrieving the latest quick statistics for multiple tags.
readonly record struct	QuickStatisticsParameters (TagQuickStatisticsParameters[] TagParams, AggregateType?[] Aggregates)
	Parameters for reading quick statistics for multiple tags.
readonly record struct	QuickStatisticsResult (string UTag, double? TimeAvg, double? RawAvg, double? StdDev, double? Min, double? Max, int Count, double? Sum, int Duration, DateTime LastGoodQualityTime, double? TimeAvgToLastPoint)
	Represents statistical summary results for a tag within a specific time range.
readonly record struct	ReadAtTimeParameters (string UTag, DateTime Timestamp)
	Parameters for reading raw data points at a specific timestamp.
readonly record struct	ReadCurrentValueParameters (string UTag)
	Parameters for reading the current value of a tag.
readonly record struct	ReadDataTypeResult (string Tag, TagDataType DataType, bool IsArray)
	Represents the result of determining the data type for a tag.
readonly record struct	ReadRawBulkParameters (ReadRawTagParameters[] TagParams, bool ReturnStartBounds=true, bool ReturnEndBounds=true)
	Parameters for reading raw data for multiple tags.
readonly record struct	ReadRawParameters (string UTag, DateTime StartTime, DateTime EndTime, bool ReturnStartBounds=true, bool ReturnEndBounds=true)
	Parameters for reading raw data from a tag.
readonly record struct	ReadRawResult (TagIdentifier Tag, DataPoints DataPoints, ReadRawError? Error=null)
	The result from reading raw data points.
readonly record struct	ReadRawTagParameters (string UTag, DateTime StartTime, DateTime EndTime)
	Represents a single tag and time range to read raw data from.
readonly record struct	ReadRawToCurrentValueParameters (string UTag, DateTime StartTime)
	Parameters for reading up to current data points for a tag.
readonly record struct	ReadSourceInfoParameters (string UTag)
	Parameters for reading source information of a tag.
readonly record struct	ReadSourceInfoResult (TagSourceInfo Value, ReadSourceInfoError? Error=null)
	Represents the result of reading tag source info.
readonly record struct	StreamRawBulkParameters (ReadRawTagParameters[] TagParams, bool ReturnStartBounds=true, bool ReturnEndBounds=true, int PageSize=512)
	Parameters for streaming raw data in bulk.
readonly record struct	TagCurrentValue (string TagName, int? TagId, IDataPoint DataPoint, TagDataType DataType, bool IsArray)
	Represents the current value of a tag.
readonly record struct	TagIdentifier (string Name, int? Id=null)
	An identifier for a tag.
readonly record struct	TagLatestQuickStatisticsParameters (TagQuickStatisticsParameters TagParams, QuickStatisticsResult CurrentResult)
	Parameters for reading the latest quick statistics for a tag.
readonly record struct	TagQuickStatisticsParameters (string UTag, DateTime StartTime, DateTime EndTime, bool IsTextSeries, InterpolationType? InterpolationType, TagDataType DataType, bool IsDrawToNow)
	Parameters for reading quick statistics for a single tag.
readonly record struct	TagSourceInfo (string Tag, string Source, string ConnectionType, string SourceUri, string SourceType, string TimeZone)
	Represents metadata about the source of a tag.

Function Documentation

◆ BulkAggExportResult()

readonly record struct dataPARC.DataSeries.SDK.BulkAggExportResult	(	DateTime[]	Timestamps,
		DataPointSet[]	Values,
		int	TotalStreamChunkNumber,
		int	CurrentChunkNumber )

Represents a result chunk from aggregate data export.

Parameters

Timestamps	Array of timestamps for the values.
Values	Array of exported aggregated values by tag.
TotalStreamChunkNumber	Total number of chunks in the stream.
CurrentChunkNumber	The current chunk number being returned.

◆ BulkExportResult()

readonly record struct dataPARC.DataSeries.SDK.BulkExportResult	(	DateTime[]	Timestamps,
		DataPointList[]	Values,
		int	TotalStreamChunkNumber,
		int	CurrentChunkNumber )

Represents a result chunk from raw data export.

Parameters

Timestamps	Array of timestamps for the values.
Values	Array of exported values by tag.
TotalStreamChunkNumber	Total number of chunks in the stream.
CurrentChunkNumber	The current chunk number being returned.

◆ BulkExportWithInterpolationParameters()

readonly record struct dataPARC.DataSeries.SDK.BulkExportWithInterpolationParameters	(	ExportParameters[]	ExportParameters,
		DateTime	StartTime,
		DateTime	EndTime,
		int	StepSize,
		AggregateType?	AggregateType,
		long	MaximumExportSize,
		RunNormalizationMode?	RunNormalizationMode,
		bool	IsInterpolateStateTag,
		bool	IncludeBounds = true )

Parameters for reading data points by aggregate type for a collection of tags.

Parameters

ExportParameters	The tags to export data for.
StartTime	The starting timestamp to export data from.
EndTime	The ending timestamp to export data to.
MaximumExportSize	Maximum data size the exporting request allows.
IncludeBounds	Mode specifying how the starting and ending timestamp should be included.
StepSize	The step size to interpolate data to.
AggregateType	The aggregate type reading tag data for.
RunNormalizationMode	The normalization mode such as ToStepSize.
IsInterpolateStateTag	Mode specifying if the interpolation includes state tags.

◆ BulkExportWithoutInterpolationParameters()

readonly record struct dataPARC.DataSeries.SDK.BulkExportWithoutInterpolationParameters	(	ExportParameters[]	ExportParameters,
		DateTime	StartTime,
		DateTime	EndTime,
		long	MaximumExportSize,
		bool	IncludeBounds = true )

Parameters for exporting raw data points without interpolation for a collection of tags.

Parameters

ExportParameters	The tags to export data for.
StartTime	The starting timestamp to export data from.
EndTime	The ending timestamp to export data to.
MaximumExportSize	Maximum data size the exporting request allows.
IncludeBounds	Mode specifying how the starting and ending timestamp should be included.

◆ DataPointSet()

readonly record struct DataPointDouble(DateTime Timestamp, int Quality, double[] Values) readonly record struct DataPointDigitalText(DateTime Timestamp, int Quality, DigitalText[] Values) readonly record struct dataPARC.DataSeries.SDK.DataPointSet	(	TagIdentifier	Tag,
		DataPoints	DataPoints )

Represents a numeric data point with double array values.

Represents a string data point with nullable string array values.

Represents a digital text value with both text and numeric representation.

Represents a digital text data point with an array of digital text values.

Represents a union of multiple data point types (double, string, digital text).

Represents a list of data points with string value of a tag.

Parameters

Tag	The identifier of the tag.
DataType	The data type of the values.
Values	The values as a string array.

Represents a set of structured data points associated with a tag.

Parameters

Tag	The identifier of the tag.
DataPoints	The data points grouped under the tag.

◆ ExportParameters()

readonly record struct dataPARC.DataSeries.SDK.ExportParameters	(	string	Tag,
		int	DeltaTime,
		InterpolationType?	InterpolationType,
		bool	ForceQualityCheck )

Parameters for exporting a tag data.

Parameters

Tag	The tag to read data from.
DeltaTime	The delta time of the tag.
InterpolationType	The interpolate type of this tag.
ForceQualityCheck	Mode specifying if forcing quality check for the export.

◆ FullyQualifiedTagName()

readonly record struct dataPARC.DataSeries.SDK.FullyQualifiedTagName	(	string	InterfaceGroup,
		string	Tag,
		string?	Interface = null,
		string?	InterfaceSet = null )

Fully identifies a tag by group, name, interface, and set.

Parameters

InterfaceGroup	The interface group name.
Tag	The tag name.
Interface	Optional interface name.
InterfaceSet	Optional interface set name.

◆ LatestQuickStatisticsParameters()

readonly record struct dataPARC.DataSeries.SDK.LatestQuickStatisticsParameters	(	TagLatestQuickStatisticsParameters[]	TagParams,
		AggregateType?[]	Aggregates )

Parameters for retrieving the latest quick statistics for multiple tags.

Parameters

TagParams	Parameters for reading the quick statistics of this tag.
Aggregates	Aggregate types that are included in the quick statistics.

◆ QuickStatisticsParameters()

readonly record struct dataPARC.DataSeries.SDK.QuickStatisticsParameters	(	TagQuickStatisticsParameters[]	TagParams,
		AggregateType?[]	Aggregates )

Parameters for reading quick statistics for multiple tags.

Parameters

TagParams	Parameters for reading the quick statistics of this tag.
Aggregates	Aggregate types that are included in the quick statistics.

◆ QuickStatisticsResult()

readonly record struct dataPARC.DataSeries.SDK.QuickStatisticsResult	(	string	UTag,
		double?	TimeAvg,
		double?	RawAvg,
		double?	StdDev,
		double?	Min,
		double?	Max,
		int	Count,
		double?	Sum,
		int	Duration,
		DateTime	LastGoodQualityTime,
		double?	TimeAvgToLastPoint )

Represents statistical summary results for a tag within a specific time range.

Parameters

UTag	The tag name.
TimeAvg	The time-weighted average value.
RawAvg	The raw average value.
StdDev	The standard deviation of values.
Min	The minimum value observed.
Max	The maximum value observed.
Count	The number of data points used in the statistics.
Sum	The total sum of all values.
Duration	The total duration for the statistics.
LastGoodQualityTime	The timestamp of the last good quality data point.
TimeAvgToLastPoint	The time-weighted average up to the last point.

◆ ReadAtTimeParameters()

readonly record struct dataPARC.DataSeries.SDK.ReadAtTimeParameters	(	string	UTag,
		DateTime	Timestamp )

Parameters for reading raw data points at a specific timestamp.

Parameters

UTag	The tag to read data from.
Timestamp	The specific timestamp.

◆ ReadCurrentValueParameters()

readonly record struct dataPARC.DataSeries.SDK.ReadCurrentValueParameters ( string UTag )

Parameters for reading the current value of a tag.

Parameters

UTag	The tag to read data from.

◆ ReadDataTypeResult()

readonly record struct dataPARC.DataSeries.SDK.ReadDataTypeResult	(	string	Tag,
		TagDataType	DataType,
		bool	IsArray )

Represents the result of determining the data type for a tag.

Parameters

Tag	The tag name.
DataType	The determined data type.
IsArray	Indicates if the tag data is an array.

◆ ReadRawBulkParameters()

readonly record struct dataPARC.DataSeries.SDK.ReadRawBulkParameters	(	ReadRawTagParameters[]	TagParams,
		bool	ReturnStartBounds = true,
		bool	ReturnEndBounds = true )

Parameters for reading raw data for multiple tags.

Parameters

TagParams	The list of params of a list of tags to read data from.
ReturnStartBounds	Indicates whether to return the start boundary value.
ReturnEndBounds	Indicates whether to return the end boundary value.

◆ ReadRawParameters()

readonly record struct dataPARC.DataSeries.SDK.ReadRawParameters	(	string	UTag,
		DateTime	StartTime,
		DateTime	EndTime,
		bool	ReturnStartBounds = true,
		bool	ReturnEndBounds = true )

Parameters for reading raw data from a tag.

Parameters

UTag	The tag to read data from.
StartTime	Start time for the data read.
EndTime	End time for the data read.
ReturnStartBounds	Indicates whether to return the start boundary value.
ReturnEndBounds	Indicates whether to return the end boundary value.

◆ ReadRawResult()

readonly record struct dataPARC.DataSeries.SDK.ReadRawResult	(	TagIdentifier	Tag,
		DataPoints	DataPoints,
		ReadRawError?	Error = null )

The result from reading raw data points.

Parameters

Tag	The tag that this read result is from.

Parameters

DataPoints The data points read.

Parameters

Error Optional error encountered during the read.

◆ ReadRawTagParameters()

readonly record struct dataPARC.DataSeries.SDK.ReadRawTagParameters	(	string	UTag,
		DateTime	StartTime,
		DateTime	EndTime )

Represents a single tag and time range to read raw data from.

Parameters

UTag	The tag to read data from.
StartTime	Start time for the data read.
EndTime	End time for the data read.

◆ ReadRawToCurrentValueParameters()

readonly record struct dataPARC.DataSeries.SDK.ReadRawToCurrentValueParameters	(	string	UTag,
		DateTime	StartTime )

Parameters for reading up to current data points for a tag.

Parameters

UTag	The tag to read data from.
StartTime	Start time for the data read.

◆ ReadSourceInfoParameters()

readonly record struct dataPARC.DataSeries.SDK.ReadSourceInfoParameters ( string UTag )

Parameters for reading source information of a tag.

Parameters

UTag	The tag to read source info from.

◆ ReadSourceInfoResult()

readonly record struct dataPARC.DataSeries.SDK.ReadSourceInfoResult	(	TagSourceInfo	Value,
		ReadSourceInfoError?	Error = null )

Represents the result of reading tag source info.

Parameters

Value	The returned source info data.
Error	Optional error encountered during the read.

◆ StreamRawBulkParameters()

readonly record struct dataPARC.DataSeries.SDK.StreamRawBulkParameters	(	ReadRawTagParameters[]	TagParams,
		bool	ReturnStartBounds = true,
		bool	ReturnEndBounds = true,
		int	PageSize = 512 )

Parameters for streaming raw data in bulk.

Parameters

TagParams	The list of params of a list of tags to read data from.
ReturnStartBounds	Indicates whether to return the start boundary value.
ReturnEndBounds	Indicates whether to return the end boundary value.
PageSize	The max number of data points in each message streamed from the server. This default is 512.

◆ TagCurrentValue()

readonly record struct dataPARC.DataSeries.SDK.TagCurrentValue	(	string	TagName,
		int?	TagId,
		IDataPoint	DataPoint,
		TagDataType	DataType,
		bool	IsArray )

Represents the current value of a tag.

Parameters

TagName	The name of the tag.
TagId	The ID of the tag, if available.
DataPoint	The current data point value.
DataType	The data type of the value.
IsArray	Whether the value is an array.

◆ TagIdentifier()

readonly record struct dataPARC.DataSeries.SDK.TagIdentifier	(	string	Name,
		int?	Id = null )

An identifier for a tag.

Parameters

Name	The name of the tag.
Id	The Id of the tag.

◆ TagLatestQuickStatisticsParameters()

readonly record struct dataPARC.DataSeries.SDK.TagLatestQuickStatisticsParameters	(	TagQuickStatisticsParameters	TagParams,
		QuickStatisticsResult	CurrentResult )

Parameters for reading the latest quick statistics for a tag.

Parameters

TagParams	Parameters for reading the quick statistics of this tag.
CurrentResult	Current quick statistics result of this tag.

◆ TagQuickStatisticsParameters()

readonly record struct dataPARC.DataSeries.SDK.TagQuickStatisticsParameters	(	string	UTag,
		DateTime	StartTime,
		DateTime	EndTime,
		bool	IsTextSeries,
		InterpolationType?	InterpolationType,
		TagDataType	DataType,
		bool	IsDrawToNow )

Parameters for reading quick statistics for a single tag.

Parameters

UTag	The tag to read data from.
StartTime	Start time for the data read.
EndTime	End time for the data read.
IsTextSeries	Indicator of text series.
InterpolationType	The interpolate type of this tag.
DataType	The data type of this tag.
IsDrawToNow	Indicator of draw to now mode of this tag.

◆ TagSourceInfo()

readonly record struct dataPARC.DataSeries.SDK.TagSourceInfo	(	string	Tag,
		string	Source,
		string	ConnectionType,
		string	SourceUri,
		string	SourceType,
		string	TimeZone )

Represents metadata about the source of a tag.

Parameters

Tag	The name of the tag.
Source	The source of the tag.
ConnectionType	The type of connection used to access the source.
SourceUri	The URI of the source data endpoint.
SourceType	The type of the source.
TimeZone	The time zone used by the source.

Classes

Enumerations

Functions

Function Documentation

◆ BulkAggExportResult()

◆ BulkExportResult()

◆ BulkExportWithInterpolationParameters()

◆ BulkExportWithoutInterpolationParameters()

◆ DataPointSet()

◆ ExportParameters()

◆ FullyQualifiedTagName()

◆ LatestQuickStatisticsParameters()

◆ QuickStatisticsParameters()

◆ QuickStatisticsResult()

◆ ReadAtTimeParameters()

◆ ReadCurrentValueParameters()

◆ ReadDataTypeResult()

◆ ReadRawBulkParameters()

◆ ReadRawParameters()

◆ ReadRawResult()

◆ ReadRawTagParameters()

◆ ReadRawToCurrentValueParameters()

◆ ReadSourceInfoParameters()

◆ ReadSourceInfoResult()

◆ StreamRawBulkParameters()

◆ TagCurrentValue()

◆ TagIdentifier()

◆ TagLatestQuickStatisticsParameters()

◆ TagQuickStatisticsParameters()

◆ TagSourceInfo()