Interface ICompositeContainerParameterDataAccess

Interface describing a CompositeContainerParameterDataAccess

Namespace: MESL.SqlRace.Domain

Assembly: MESL.SqlRace.Domain.dll

Syntax

public interface ICompositeContainerParameterDataAccess : IDisposable

Properties

IsInitialized

Gets or sets a value indicating whether this instance is initialized.

Declaration

bool IsInitialized { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is initialized; otherwise, false.

ParameterIdentifier

Parameter Identifier

Declaration

string ParameterIdentifier { get; }

Property Value

Type	Description
System.String

SampleTime

Gets or sets the sample time (in nanoseconds) for the data. This value will only affect requests to get data (using the GetNextData method ) and will not affect calls to get samples (using the GetNextSamples/GetPreviousSamples methods).

Declaration

long SampleTime { get; set; }

Property Value

Type	Description
System.Int64

Remarks

This time is the interval between data samples. For example: 1,000,000 ns = 1000Hz 10,000,000 ns = 100Hz 100,000,000 ns = 10Hz 1,000,000,000 ns = 1Hz If this value is not set then the default sample time is 100Hz (10,000,000 ns).

UnderlyingPdas

Underlying PDA's

Declaration

IReadOnlyDictionary<CompositeSessionKey, ICompositeParameterDataAccess> UnderlyingPdas { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<MAT.OCS.Core.CompositeSessionKey, ICompositeParameterDataAccess>

Methods

GetDataStatistics(Int64, Int64, Boolean, StatisticOption, Boolean)

Gets the data statistics.

Declaration

Dictionary<CompositeSessionKey, CompositeStatistics> GetDataStatistics(long startTimeStamp, long duration, bool weightStatistics, StatisticOption statisticOption, bool isEos = false)

Parameters

Type	Name	Description
System.Int64	startTimeStamp	The start time stamp.
System.Int64	duration	The duration.
System.Boolean	weightStatistics	if set to true [weight statistics].
StatisticOption	statisticOption	The statistic option.
System.Boolean	isEos	Whether the request is for an Eos statistic, false by default

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, CompositeStatistics>

GetNextData(Dictionary<CompositeSessionKey, Int64[]>, SampleModeType, Boolean, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns sampled data for each of the timestamps passed in the call, using the timestamps provided for each session rather than allowing SQLRace to apply the offset

Declaration

void GetNextData(Dictionary<CompositeSessionKey, long[]> sampleTimestamps, SampleModeType sampleMode, bool interpolate, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	sampleTimestamps	The sample timestamps for each session.
SampleModeType	sampleMode	The sample mode.
System.Boolean	interpolate	If set to true, returned data is interpolated.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Sampled data.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

GetNextData(Dictionary<CompositeSessionKey, Int64[]>, Boolean, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns the next sampled data values and status based on the timestamps requested using min/max sampler. Uses timestamps provided for each secondary session rather than relying on SQLRace to do this

Declaration

void GetNextData(Dictionary<CompositeSessionKey, long[]> timestamps, bool interpolate, ref Dictionary<CompositeSessionKey, double[]> minimumValues, ref Dictionary<CompositeSessionKey, double[]> maximumValues, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	timestamps	Timestamps for all sessions at which to return data.
System.Boolean	interpolate	If set to true, returned data is interpolated.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	minimumValues	The minimum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	maximumValues	The maximum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

GetNextData(Dictionary<CompositeSessionKey, Int64[]>, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns sampled data for each of the timestamps passed in the call, using the timestamps provided for each session rather than allowing SQLRace to apply the offset

Declaration

void GetNextData(Dictionary<CompositeSessionKey, long[]> sampleTimestamps, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	sampleTimestamps	The sample timestamps.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Sampled data.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

Remarks

Uses SampleModeType.Mean and does not use linear interpolation between samples.

GetNextData(Int32, SampleModeType, Boolean, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Gets the next sampled data values and status based on the number of samples requested.

Declaration

void GetNextData(int numberOfSamples, SampleModeType sampleMode, bool interpolate, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	Number of samples to retrieve.
SampleModeType	sampleMode	The sample mode.
System.Boolean	interpolate	If set to true, returned data is interpolated.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Sampled data.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

Remarks

On completion of this call, the CurrentTime will be set to the end of the returned data.

GetNextData(Int32, Boolean, ref Dictionary<CompositeSessionKey, MinimumMaximumMeanDouble[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns the next sampled data values and status based on the number of samples requested using min/max/mean sampler.

Declaration

void GetNextData(int numberOfSamples, bool interpolate, ref Dictionary<CompositeSessionKey, MinimumMaximumMeanDouble[]> minimumMaximumMeanValues, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	Number of samples to retrieve.
System.Boolean	interpolate	If set to true, returned data is interpolated.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MinimumMaximumMeanDouble[]>	minimumMaximumMeanValues	The minimum/maximum/mean values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

Remarks

Does not use linear interpolation between samples. On completion of this call, the CurrentTime will be set to the end of the returned data.

GetNextData(Int32, Boolean, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns the next sampled data values and status based on the number of samples requested using min/max sampler.

Declaration

void GetNextData(int numberOfSamples, bool interpolate, ref Dictionary<CompositeSessionKey, double[]> minimumValues, ref Dictionary<CompositeSessionKey, double[]> maximumValues, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	Number of samples to retrieve.
System.Boolean	interpolate	If set to true, returned data is interpolated.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	minimumValues	The minimum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	maximumValues	The maximum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

Remarks

On completion of this call, the CurrentTime will be set to the end of the returned data.

GetNextData(Int32, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns the next sampled data values and status based on the number of samples requested.

Declaration

void GetNextData(int numberOfSamples, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	Number of samples to retrieve.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Sampled data.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

Remarks

Uses SampleModeType.Mean and does not interpolate between samples. On completion of this call, the CurrentTime will be set to the end of the returned data.

GetNextData(Int32, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns the next sampled data values and status based on the number of samples requested using min/max sampler.

Declaration

void GetNextData(int numberOfSamples, ref Dictionary<CompositeSessionKey, double[]> minimumValues, ref Dictionary<CompositeSessionKey, double[]> maximumValues, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	Number of samples to retrieve.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	minimumValues	The minimum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	maximumValues	The maximum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

Remarks

Does not use linear interpolation between samples. On completion of this call, the CurrentTime will be set to the end of the returned data.

GetNextData(Int64[], SampleModeType, Boolean)

Returns sampled data for each of the timestamps passed in the call.

Declaration

Dictionary<CompositeSessionKey, ParameterValues> GetNextData(long[] sampleTimestamps, SampleModeType sampleMode, bool interpolate)

Parameters

Type	Name	Description
System.Int64[]	sampleTimestamps	The sample timestamps.
SampleModeType	sampleMode	The sample mode.
System.Boolean	interpolate	If set to true, returned data is interpolated.

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.ParameterValues>

GetNextData(Int64[], SampleModeType, Boolean, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns sampled data for each of the timestamps passed in the call, allowing SQLRace to apply offsets for secondary sessions.

Declaration

void GetNextData(long[] sampleTimestamps, SampleModeType sampleMode, bool interpolate, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int64[]	sampleTimestamps	The sample timestamps.
SampleModeType	sampleMode	The sample mode.
System.Boolean	interpolate	If set to true, returned data is interpolated.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Sampled data.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

GetNextData(Int64[], Boolean)

Returns the next sampled data values and status based on the timestamps requested using min/max sampler.

Declaration

Dictionary<CompositeSessionKey, ParameterValues> GetNextData(long[] timestamps, bool interpolate)

Parameters

Type	Name	Description
System.Int64[]	timestamps	Timestamps at which to return data.
System.Boolean	interpolate	If set to true, returned data is interpolated.

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.ParameterValues>

GetNextData(Int64[], Boolean, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns the next sampled data values and status based on the timestamps requested using min/max sampler. Allows SQLRace to apply offsets for secondary sessions

Declaration

void GetNextData(long[] timestamps, bool interpolate, ref Dictionary<CompositeSessionKey, double[]> minimumValues, ref Dictionary<CompositeSessionKey, double[]> maximumValues, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int64[]	timestamps	Timestamps at which to return data.
System.Boolean	interpolate	If set to true, returned data is interpolated.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	minimumValues	The minimum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	maximumValues	The maximum values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

GetNextData(Int64[], ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>)

Returns sampled data for each of the timestamps passed in the call, allowing SQLRace to apply offsets for secondary sessions.

Declaration

void GetNextData(long[] sampleTimestamps, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status)

Parameters

Type	Name	Description
System.Int64[]	sampleTimestamps	The sample timestamps.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Sampled data.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the sample.

Remarks

Uses SampleModeType.Mean and does not use linear interpolation between samples.

GetNextSamples(Int32)

Returns the next raw data samples, their MAT.OCS.Core.DataStatusType and timestamps between the current time and the endTime provided.

Declaration

Dictionary<CompositeSessionKey, ParameterValues> GetNextSamples(int numberOfSamples)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	The end time.

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.ParameterValues>	The number of samples available.

GetNextSamples(Int32, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>, ref Dictionary<CompositeSessionKey, Int64[]>)

Returns the next raw data samples, their MAT.OCS.Core.DataStatusType and timestamps from the current time.

Declaration

int[] GetNextSamples(int numberOfSamples, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status, ref Dictionary<CompositeSessionKey, long[]> time)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	The number of samples required.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Raw data samples.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the raw samples.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	time	Timestamps for the raw samples.

Returns

Type	Description
System.Int32[]	The number of samples available for each underlying PDA

GetNextSamples(Int64, Boolean)

Returns the next raw data samples, their MAT.OCS.Core.DataStatusType and timestamps between the current time and the endTime provided.

Declaration

Dictionary<CompositeSessionKey, ParameterValues> GetNextSamples(long endTime, bool useRelativeTimes = false)

Parameters

Type	Name	Description
System.Int64	endTime	The end time.
System.Boolean	useRelativeTimes	Indicates if the time range for the request for the compare session should be built relative to the duration of the single lap. E.g.for the first compare lap, then add compare lap duration to the timestamps for each subsequent lap, so if compare lap is 2 mins long and time stamps run from 15:00:00 to 15:02:00, the first lap would use these timestamps, the second lap would add 2 mins and use timetstamps between 15:02:00 to 15:04:00 etc

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.ParameterValues>	The number of samples available.

GetNextSamples(Int64, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>, ref Dictionary<CompositeSessionKey, Int64[]>)

Returns the next raw data samples, their MAT.OCS.Core.DataStatusType and timestamps between the current time and the endTime provided.

Declaration

int[] GetNextSamples(long endTime, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status, ref Dictionary<CompositeSessionKey, long[]> time)

Parameters

Type	Name	Description
System.Int64	endTime	The end time.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Raw data values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the raw data values
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	time	Timestamps of the raw data values.

Returns

Type	Description
System.Int32[]	The number of samples available.

GetPreviousSamples(Int32)

Gets the previous samples.

Declaration

Dictionary<CompositeSessionKey, ParameterValues> GetPreviousSamples(int sampleCount)

Parameters

Type	Name	Description
System.Int32	sampleCount	The sample count.

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.ParameterValues>

GetPreviousSamples(Int32, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>, ref Dictionary<CompositeSessionKey, Int64[]>)

Returns the previous raw data samples, their MAT.OCS.Core.DataStatusType and time based on the number of samples requested.

Declaration

int[] GetPreviousSamples(int numberOfSamples, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status, ref Dictionary<CompositeSessionKey, long[]> time)

Parameters

Type	Name	Description
System.Int32	numberOfSamples	Number of samples to retrieve.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Raw data values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the raw data values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	time	Timestamps of the raw data values.

Returns

Type	Description
System.Int32[]	The number of samples available for each underlying PDA

GetPreviousSamples(Int64)

Returns the previous raw data samples, their MAT.OCS.Core.DataStatusType and timestamp, starting at endTime.

Declaration

Dictionary<CompositeSessionKey, ParameterValues> GetPreviousSamples(long endTime)

Parameters

Type	Name	Description
System.Int64	endTime	The end time.

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.ParameterValues>	Number of samples available for each underlying PDA

GetPreviousSamples(Int64, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>, ref Dictionary<CompositeSessionKey, Int64[]>)

Returns the previous raw data samples, their MAT.OCS.Core.DataStatusType and timestamp, starting at endTime.

Declaration

int[] GetPreviousSamples(long endTime, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status, ref Dictionary<CompositeSessionKey, long[]> time)

Parameters

Type	Name	Description
System.Int64	endTime	The end time.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Raw data values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the raw data values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	time	Timestamps of the data.

Returns

Type	Description
System.Int32[]	Number of samples available for each underlying PDA

GetSamples(Int32, Int64, Int64, ref Dictionary<CompositeSessionKey, Double[]>, ref Dictionary<CompositeSessionKey, DataStatusType[]>, ref Dictionary<CompositeSessionKey, Int64[]>)

Returns a number of raw data samples between a start and end sample time.

Declaration

int[] GetSamples(int maximumNumberOfSamples, long startTimeStamp, long endTimeStamp, ref Dictionary<CompositeSessionKey, double[]> data, ref Dictionary<CompositeSessionKey, DataStatusType[]> status, ref Dictionary<CompositeSessionKey, long[]> time)

Parameters

Type	Name	Description
System.Int32	maximumNumberOfSamples	The maximum number of samples to request.
System.Int64	startTimeStamp	The start time stamp.
System.Int64	endTimeStamp	The end time stamp.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Double[]>	data	Raw data values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, MAT.OCS.Core.DataStatusType[]>	status	MAT.OCS.Core.DataStatusType of the raw data values.
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Int64[]>	time	Timestamps of the data.

Returns

Type	Description
System.Int32[]	The number of samples available for each underlying PDA

GetSamplesCount(Int64, Int64)

Gets the sample counts of all underlying sessions.

Declaration

Dictionary<CompositeSessionKey, Dictionary<SessionKey, Nullable<long>>> GetSamplesCount(long startTimeStamp, long endTimeStamp)

Parameters

Type	Name	Description
System.Int64	startTimeStamp	The start time stamp.
System.Int64	endTimeStamp	The end time stamp.

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Collections.Generic.Dictionary<MAT.OCS.Core.SessionKey, System.Nullable<System.Int64>>>	The sample count for each underlying session.

GetSamplesCountEstimate(Int64, Int64)

Returns the theoretical sample count between a specified start and end time based on the highest frequency channel for this PDA's Parameter. If the return value is zero means that was impossible to calculate the sample count, or this PDA is created on a SlowRow parameter

Declaration

Dictionary<CompositeSessionKey, Dictionary<SessionKey, Nullable<long>>> GetSamplesCountEstimate(long startTimeStamp, long endTimeStamp)

Parameters

Type	Name	Description
System.Int64	startTimeStamp	Start time stamp of the data.
System.Int64	endTimeStamp	End time stamp of the data.

Returns

Type	Description
System.Collections.Generic.Dictionary<MAT.OCS.Core.CompositeSessionKey, System.Collections.Generic.Dictionary<MAT.OCS.Core.SessionKey, System.Nullable<System.Int64>>>	Theoretical sample count between the start and end time, or zero if it was impossible to calculate, or this PDA is created on a SlowRow parameter.

GoTo(Double)

Positions the ParameterDataAccess object to a specific position (i.e. when the X Axis is not Time) within the parameter's data. This value can be used to set the start point for GetNextData calls.

Declaration

void GoTo(double position)

Parameters

Type	Name	Description
System.Double	position	Required position.

GoTo(Int64)

Positions the ParameterDataAccess object to a specific time within the parameter's data. This value can be used to set the start point for GetNextData calls.

Declaration

void GoTo(long time)

Parameters

Type	Name	Description
System.Int64	time	Required time location in nano-seconds.

SetMapper(String)

Sets the mapper to be used for GetNextData calls. The mapper is identified by its name. The API includes default mappers for time (which is the default for a PDA) and distance. These are named "time" and "distance" respectively. The API caller may specify another mapping name for a custom mapper that has been registered with the API (see MapperService). If a mapper is set which is not registered then an invalid argument exception will be thrown.

Declaration

void SetMapper(string mapper)

Parameters

Type	Name	Description
System.String	mapper	The name of the mapper.

SetSampleIncrement(Double)

Sets the current sample increment for the PDA, when the X Axis is not Time

Declaration

void SetSampleIncrement(double increment)

Parameters

Type	Name	Description
System.Double	increment	The required sample increment.

SetSampleIncrement(Int64)

Sets the current sample increment for the PDA, in nanoseconds (supersedes SampleTime). This value will only affect requests to get data (using the GetNextData method ) and will not affect calls to get samples (using the GetSamples/GetNextSamples/GetPreviousSamples methods).

Declaration

void SetSampleIncrement(long increment)

Parameters

Type	Name	Description
System.Int64	increment	The required sample increment

Remarks

This time is the interval between data samples. For example: 1,000,000 ns = 1000Hz 10,000,000 ns = 100Hz 100,000,000 ns = 10Hz 1,000,000,000 ns = 1Hz If this value is not set then the default sample time is 100Hz (10,000,000 ns).

Events

Invalidated

Occurs when [invalidated].

Declaration

event EventHandler Invalidated

Event Type

Type	Description
System.EventHandler

UnderlyingDataSourceChanged

Occurs when [underlying data source changed]. This event will be raised if the source data context of one of the underlying PDAs of this composite PDA change - any previously-requested data is invalid.

Declaration

event EventHandler UnderlyingDataSourceChanged

Event Type

Type	Description
System.EventHandler