Structures

Represents a User

Structure containing details of database document changes.

Changes can include creation, data updates, documents replicated from the server, or documents deleted.

Query parameter structure to use when querying a known list of keys.

Query parameter structure to use when querying a range of keys.

Aggregation functions allow you to perform mathematical operations on a number of data points to create a reduced number of data points. Aggregation functions each perform distinct mathematical operations and are performed on all the data points included in the sampling period.

Groups allow you to construct a query to return data points in specified groups

Groups can be made by providing one or more of the following attribute:

name: Allows data points to be the name of a property of the data point. For example you could group data points by there quality by setting name = quality

rangeSize: Is the number of values to place in a group. For example, a range size of 10 puts measurements between 0-9 in one group, 10-19 in the next group, and so on

groupCount: Defines the maximum number of groups to return. For example if you set the rangeSize to 1 hour and you set the groupCount to 24 than you would get 24 groups each with an hours worth of data points

Example of grouping by quality:

   let group = TagGroup
   group.name = "quality"
   group.rangeSize = 4
   group.groupCount = 4
   ...

The above example would give you 4 groups of quality (Bad, Uncertain, Not Acceptable and Good). The first group would contain all quality values for bad data points, the second group would contain all the data points for uncertain data points and so on.

Queries enable you to filter and aggregate data based on properties of a Tag and its data points.

Time Series tags can have properties with different types of data values that represent quality, type, attributes, etc… of a data point. For example you could query all tags and all data points whos quality is Good, filtering out quality levels less than Good.

Queries can combined multiple elements or by using a single one. For example a TagQuery could specify a grouping with an aggregation and limit of how many data points to return or it would simply be a single item like limit to the last two data points.

Example of a query that would return tags grouped by their quality level and limited to the last 3 values

   let tagGroup = TagGroup(name: "quality")
   let tagQuery = TagQuery(name: "sensorTag", group: tagGroup, limit: 3)
   ...

The tag for a data point request and the values that were retreived by a data point request

DataPoint response information about how the data points are grouped for a tag

The value of a data point.

Each data point has three pieces of information. A timestamp, measurement and quality of the data point.

A single result for a tag that has been fetched from the Time Series service

The TagDataPointResult provides the grouping information for the tag, the data point value, any filters that have been applied and any attributes of the tag

OptionSet indicating endpoint connectivity statuses

Model for Predix Sync server information as returned by the PredixSyncServerInformationFetcher

Configuration for Authentication

Configuration for TimeSeries

Configuration for AssetManager

Error codes for PredixSDK errors

Sampling for a given a Time Series aggregation

Specifies a range of time that would allow you to request data points that happened within that time range. The operation works much like the Swift Range object.

TimeRange can work with partial and close ranges

An example of a closed range would be requesting all times from 0 to 2

   let timeRange = TimeRange(0...2)

An example of a partialRange would be asking for everything up to 2

   let timeRange = TimeRange(...2)

or anything from 2

   let timeRange = TimeRange(2...)

A Time Series request to retrieve a datapoint or datapoints.

The DataPointRequest allows you to setup a request that can be used to fetch the datapoints for a set of tags and tag attributes.

Basic Usage:

   let dataPointRequest = DataPointRequest(["sensorTag1"])

In this example a request would be created that when fetched would return all data points for sensorTag1

A LatestDataPointRequest fetches the latest data points for an array of given tag names

A latest data point request will return the last 15 days of data points received by the Time Series service. Latest data points does not support running a TagQuery to aggregate or filter the results.

Stats object which holds rawCount attribute

The response for a DataPointRequest

Request Parameters to fetch selected number of Assets (filtering criteria).

Asset object holds the Predix-Assets objects returned from the backend service.

A Model that represents a Predix UAA session. Please visit the UAA documentation site for more information

Handles registering device for push notifications on the Predix Push Notification service

Example usage:

let pushRegistration = PushNotificationRegistation(token: deviceToken, userName: userName)

pushRegistration.register(to: pushServiceURL, with: myApplicationKey)