Interface IParameterDataAccessServiceClient
Parameter data access service client.
Namespace: MAT.Atlas.Automation.Client.Services.Interface
Assembly: MAT.Atlas.Automation.Client.dll
Syntax
public interface IParameterDataAccessServiceClient
Methods
GetDataStatistics(SessionId, String, Int64, Int64, StatisticOption)
Get unweighted 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. |
GetDataStatisticsVba(SessionId, String, Double, Double, StatisticOption)
Get unweighted statistics for a parameter over a specified time range for VBA.
Declaration
StatisticsData GetDataStatisticsVba(SessionId sessionId, string parameterIdentifier, double startTime, double duration, StatisticOption statisticOptions)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Double | startTime | |
System.Double | duration | |
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. |
GetNextDataVba(SessionId, String, Int32, 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)) for VBA.
Declaration
ParameterValues GetNextDataVba(SessionId sessionId, string parameterIdentifier, int numberOfSamples, SampleMode sampleMode, bool interpolate)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Parameter identifier. |
System.Int32 | numberOfSamples | |
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. |
GetNextSamplesToTimeVba(SessionId, String, Double)
Get next samples (start of time range set via Goto(SessionId, String, Int64)) over a specified time range for VBA.
Declaration
ParameterValues GetNextSamplesToTimeVba(SessionId sessionId, string parameterIdentifier, double endTime)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Double | endTime |
Returns
Type | Description |
---|---|
ParameterValues | Requested samples. |
GetNextSamplesVba(SessionId, String, Int32)
Get next samples (start of time range set via Goto(SessionId, String, Int64)) for a maximum number of samples for VBA.
Declaration
ParameterValues GetNextSamplesVba(SessionId sessionId, string parameterIdentifier, int numberOfSamples)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int32 | numberOfSamples |
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. |
GetPreviousSamplesVba(SessionId, String, Int32)
Get previous samples (start of time range set via Goto(SessionId, String, Int64)) for a maximum number of samples for VBA.
Declaration
ParameterValues GetPreviousSamplesVba(SessionId sessionId, string parameterIdentifier, int numberOfSamples)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Int32 | numberOfSamples |
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. |
GetSamplesCountEstimateVba(SessionId, String, Double, Double)
Get estimated number of samples for a parameter over a specified time range for VBA.
Declaration
int GetSamplesCountEstimateVba(SessionId sessionId, string parameterIdentifier, double startTime, double endTime)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Double | startTime | |
System.Double | endTime |
Returns
Type | Description |
---|---|
System.Int32 | 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. |
GetWeightedDataStatisticsVba(SessionId, String, Double, Double, StatisticOption)
Get weighted statistics for a parameter over a specified time range for VBA.
Declaration
StatisticsData GetWeightedDataStatisticsVba(SessionId sessionId, string parameterIdentifier, double startTime, double duration, StatisticOption statisticOptions)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Double | startTime | |
System.Double | duration | |
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) |
GotoVba(SessionId, String, Double)
Set start of time range for subsequent data/sample requests for VBA.
Declaration
void GotoVba(SessionId sessionId, string parameterIdentifier, double time)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Double | time |
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). |
SetSampleIncrementVba(SessionId, String, Double)
Set sample increment for subsequent data requests for VBA.
Declaration
void SetSampleIncrementVba(SessionId sessionId, string parameterIdentifier, double sampleIncrement)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
System.Double | sampleIncrement |