Interface IParameterDataAccessService
Parameter data access service.
Namespace: MAT.Atlas.Automation.Api
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
[AutomationService("ParameterDataAccess")]
public interface IParameterDataAccessService : IAutomationService
Methods
GetDataStatistics(SessionId, String, Int64, Int64, StatisticOption)
Get statistics for a parameter over a specified time range.
Declaration
StatisticsData GetDataStatistics(SessionId sessionId, string parameterIdentifier, long startTime, long duration, StatisticOption statisticOptions)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | startTime | Start of time range (nanoseconds). |
System.Int64 | duration | Length of time range (nanoseconds). |
StatisticOption | statisticOptions | What statistics to calculate. |
Returns
Type | Description |
---|---|
StatisticsData | Requested statistics. |
GetNextData(SessionId, String, Int64, SampleMode, Boolean)
Get next data (start of time range set via Goto(SessionId, String, Int64)) with fixed increment (sample increment set via SetSampleIncrement(SessionId, String, Int64)).
Declaration
ParameterValues GetNextData(SessionId sessionId, string parameterIdentifier, long numberOfSamples, SampleMode sampleMode, bool interpolate)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Parameter identifier. |
System.Int64 | numberOfSamples | Maximum number of data values to return. |
SampleMode | sampleMode | Sampling mode. |
System.Boolean | interpolate | Whether to interpolate. |
Returns
Type | Description |
---|---|
ParameterValues | Requested data. |
GetNextSamples(SessionId, String, Int64)
Get next samples (start of time range set via Goto(SessionId, String, Int64)) for a maximum number of samples.
Declaration
ParameterValues GetNextSamples(SessionId sessionId, string parameterIdentifier, long numberOfSamples)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | numberOfSamples | Maximum number of samples to return. |
Returns
Type | Description |
---|---|
ParameterValues | Requested samples. |
GetNextSamplesToTime(SessionId, String, Int64)
Get next samples (start of time range set via Goto(SessionId, String, Int64)) over a specified time range.
Declaration
ParameterValues GetNextSamplesToTime(SessionId sessionId, string parameterIdentifier, long endTime)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | endTime | End of time range (nanoseconds). |
Returns
Type | Description |
---|---|
ParameterValues | Requested samples. |
GetPreviousSamples(SessionId, String, Int64)
Get previous samples (start of time range set via Goto(SessionId, String, Int64)) for a maximum number of samples.
Declaration
ParameterValues GetPreviousSamples(SessionId sessionId, string parameterIdentifier, long numberOfSamples)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | numberOfSamples | Maximum number of samples to return. |
Returns
Type | Description |
---|---|
ParameterValues | Requested samples. |
GetSamplesCountEstimate(SessionId, String, Int64, Int64)
Get estimated number of samples for a parameter over a specified time range.
Declaration
long GetSamplesCountEstimate(SessionId sessionId, string parameterIdentifier, long startTime, long endTime)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | startTime | Start of time range (nanoseconds). |
System.Int64 | endTime | End of time range (nanoseconds). |
Returns
Type | Description |
---|---|
System.Int64 | Estimated sample count. |
GetWeightedDataStatistics(SessionId, String, Int64, Int64, StatisticOption)
Get weighted statistics for a parameter over a specified time range.
Declaration
StatisticsData GetWeightedDataStatistics(SessionId sessionId, string parameterIdentifier, long startTime, long duration, StatisticOption statisticOptions)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | startTime | Start of time range (nanoseconds). |
System.Int64 | duration | Length of time range (nanoseconds). |
StatisticOption | statisticOptions | What statistics to calculate. |
Returns
Type | Description |
---|---|
StatisticsData | Requested statistics. |
Goto(SessionId, String, Int64)
Set start of time range for subsequent data/sample requests.
Declaration
void Goto(SessionId sessionId, string parameterIdentifier, long time)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | time | Start of time range (nanoseconds) |
SetSampleIncrement(SessionId, String, Int64)
Set sample increment for subsequent data requests.
Declaration
void SetSampleIncrement(SessionId sessionId, string parameterIdentifier, long sampleIncrement)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int64 | sampleIncrement | Sample increment (nanoseconds). |