TimeSeriesManager

public class TimeSeriesManager

TimeSeriesManager provides an API that allows you to retreive tags and datapoints from a Time Series instance running in PredixCluod.

The TimeSeriesManager is intended to work with the Predix Cloud Time Series service, for more information please see the Time Series service documentation.

Example usage:

   // First, create a TimeSeriesManagerConfiguration and populate the configuration with your Time Series service information.
   let config = TimeSeriesManagerConfiguration(predixZoneId: "<your ZoneID used for the Time Series Service>")

   // Next, create a TimeSeriesManager with the TimeSeriesManagerConfiguration
   let manager = TimeSeriesManager(configuration: config)

   // Then call the API. The completionHandler will be called when the process finishes.
   self.getManager().getTags(completionHandler:{(tags,  error) in
   ...
}

configuration
The configuration tells the TimeSeriesManager how to connect to the Time Series Service running in Predix Cloud
Declaration
Swift

public internal(set) var configuration: TimeSeriesManagerConfiguration


                    
                    
                    init(configuration:)

Initializes the TimeSeriesManager with a the time series configuration for the Time Series Service

Declaration

Swift

required public init(configuration: TimeSeriesManagerConfiguration)

Parameters


                                configuration

A TimeSeriesManagerConfiguration for this manager


                    
                    
                    fetchTagNames(completionHandler:)

Fetches all of the available Time Series Tags for the configured Time Series instance

Declaration

Swift

public func fetchTagNames(completionHandler: @escaping ( _ tags: [String], _ error: Error?) -> Void)

Parameters

`completionHandler`	closure to call when the fetch has completed
`tags`	An array of tags. If an error occurs an empty array will be returned
`error`	In the event of an error the error parameter will contain information about why the fetch failed


                    
                    
                    fetchDataPoints(request:completionHandler:)

Fetches datapoints for a given DataPointRequest

Declaration

Swift

public func fetchDataPoints(request: DataPointRequest, completionHandler: @escaping ( _ timeSeriesResponse: DataPointResponse?, _ error: Error?) -> Void)

Parameters

`request`	A DataPointRequest that instructs fetch about the type of Time Series data to retrieve
`completionHandler`	closure to call when the fetch has completed
`timeSeriesResponse`	The reponse for the given DataPointRequest. The DataPointResponse will be nil if an error occurs
`error`	In the event of an error the error parameter will contain information about why the fetch failed


                    
                    
                    fetchLatestDataPoints(request:completionHandler:)

Fetches the latest datapoints for a given DataPointRequest

Declaration

Swift

public func fetchLatestDataPoints(request: LatestDataPointRequest, completionHandler: @escaping ( _ timeSeriesResponse: DataPointResponse?, _ error: Error?) -> Void)

Parameters

`request`	A LatestDataPointRequest that instructs fetch about the type of Time Series data to retrieve
`completionHandler`	closure to call when the fetch has completed
`timeSeriesResponse`	The reponse for the given LatestDataPointRequest. The DataPointResponse will be nil if an error occurs
`error`	In the event of an error the error parameter will contain information about why the fetch failed