Interface ISessionReader

Interface class contains the signatures of properties and functions to read the information about session. No operation can be called after CloseSession() is called.

Inherited Members

System.IDisposable.Dispose()

Namespace: MAT.AtlasSessionApi

Assembly: MAT.AtlasSessionApi.dll

Syntax

public interface ISessionReader : IDisposable

Properties

Channels

Collection of key/value pairs for the channels where key is defined as channel id.

Declaration

IReadOnlyDictionary<uint, Channel> Channels { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.UInt32, Channel>

Conversions

Collection of key/value pairs for the conversions where key is defined as conversion identifier.

Declaration

IReadOnlyDictionary<string, Conversion> Conversions { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, Conversion>

EndTime

End time of the session.

Declaration

long EndTime { get; }

Property Value

Type	Description
System.Int64

Laps

Collection of laps and their description like lap number, type and start/end time of lap.

Declaration

IEnumerable<Lap> Laps { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Lap>

Parameters

Collection of parameters and their descriptions.

Declaration

IEnumerable<Parameter> Parameters { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Parameter>

ParametersByIdentifier

Collection of key/value pairs for the parameters where key is defined as parameter identifier.

Declaration

IReadOnlyDictionary<string, Parameter> ParametersByIdentifier { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, Parameter>

SessionDetail

Update the session details. The new details will be saved in .sse file.

Declaration

ISessionDetail SessionDetail { get; set; }

Property Value

Type	Description
ISessionDetail

SessionItems

Collection of key/value pairs for the session details.

Declaration

IDictionary<string, string> SessionItems { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>

StartTime

Start time of the session.

Declaration

long StartTime { get; }

Property Value

Type	Description
System.Int64

VirtualParameters

Collection of virtual parameters.

Declaration

IEnumerable<VirtualParameter> VirtualParameters { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<VirtualParameter>

VirtualParametersByIdentifier

Collection of key/value pairs for the virtual parameters where key is defined as virtual parameter identifier.

Declaration

IReadOnlyDictionary<string, VirtualParameter> VirtualParametersByIdentifier { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, VirtualParameter>

Methods

CloseSession()

Close the session object to destroy the session reader object.

Declaration

void CloseSession()

GetData(String, Int64, Int64, Frequency, Boolean)

Gets the merged parameter data for given interval. It will return the data for timestamp between start and end timestamp. Data can be interpolate and default interpolation is off.

Declaration

DataPoint[] GetData(string identifier, long startTime, long endTime, Frequency frequency, bool interpolate = false)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.Int64	startTime	Start timestamp for requested sample.
System.Int64	endTime	End timestamp for requested sample.
Frequency	frequency	Frequency object to fetch the data.
System.Boolean	interpolate	Flag to interpolate samples. Default is false.

Returns

Type	Description
DataPoint[]	Sample value along with it's status.

GetData(String, Int64, Int64, Frequency, out Double[], out UInt16[], out Int64[], Boolean)

Gets the merged parameter data for given interval. It will return the data for timestamp between start and end timestamp. Data can be interpolate and default interpolation is off.

Declaration

void GetData(string identifier, long startTime, long endTime, Frequency frequency, out double[] values, out ushort[] statuses, out long[] timestamps, bool interpolate = false)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.Int64	startTime	Start timestamp for requested sample.
System.Int64	endTime	End timestamp for requested sample.
Frequency	frequency	Frequency object to fetch the data.
System.Double[]	values	The values.
System.UInt16[]	statuses	The statuses.
System.Int64[]	timestamps	The timestamps.
System.Boolean	interpolate	Flag to interpolate samples. Default is false.

GetData(String, UInt32, Int64, Int64, Frequency, Boolean)

Gets the parameter data for the given channel and interval. It will return the data for timestamp between start and end timestamp. Data can be interpolate and default interpolation is off.

Declaration

DataPoint[] GetData(string identifier, uint channelId, long startTime, long endTime, Frequency frequency, bool interpolate = false)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.UInt32	channelId	Channel id.
System.Int64	startTime	Start timestamp for requested sample.
System.Int64	endTime	End timestamp for requested sample.
Frequency	frequency	Frequency object to fetch the data.
System.Boolean	interpolate	Flag to interpolate samples. Default is false.

Returns

Type	Description
DataPoint[]	Sample value along with it's status.

GetData(String, UInt32, Int64, Int64, Frequency, out Double[], out UInt16[], out Int64[], Boolean)

Gets the parameter data for the given channel and interval. It will return the data for timestamp between start and end timestamp. Data can be interpolate and default interpolation is off.

Declaration

void GetData(string identifier, uint channelId, long startTime, long endTime, Frequency frequency, out double[] values, out ushort[] statuses, out long[] timestamps, bool interpolate = false)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.UInt32	channelId	Channel id.
System.Int64	startTime	Start timestamp for requested sample.
System.Int64	endTime	End timestamp for requested sample.
Frequency	frequency	Frequency object to fetch the data.
System.Double[]	values	The values.
System.UInt16[]	statuses	The statuses.
System.Int64[]	timestamps	The timestamps.
System.Boolean	interpolate	Flag to interpolate samples. Default is false.

GetSamples(String, Int64, Int64)

Gets the merged parameter samples for timestamp between start and end timestamp.

Declaration

DataPoint[] GetSamples(string identifier, long startTime, long endTime)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.Int64	startTime	Start timestamp for requested sample.
System.Int64	endTime	End timestamp for requested sample.

Returns

Type	Description
DataPoint[]	Sample value along with it's status.

GetSamples(String, Int64, Int64, out Double[], out UInt16[], out Int64[])

Gets the merged parameter samples for timestamp between start and end timestamp.

Declaration

void GetSamples(string identifier, long startTime, long endTime, out double[] values, out ushort[] statuses, out long[] timestamps)

Parameters

Type	Name	Description
System.String	identifier	The identifier.
System.Int64	startTime	The start time.
System.Int64	endTime	The end time.
System.Double[]	values	The values.
System.UInt16[]	statuses	The statuses.
System.Int64[]	timestamps	The timestamps.

GetSamples(String, UInt32, Int64, Int64)

Gets the parameter samples for specific channel. It will return the data for timestamp between start and end timestamp.

Declaration

DataPoint[] GetSamples(string identifier, uint channelId, long startTime, long endTime)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.UInt32	channelId	Channel id.
System.Int64	startTime	Start timestamp for requested sample.
System.Int64	endTime	End timestamp for requested sample.

Returns

Type	Description
DataPoint[]	Sample value along with it's status.

GetSamples(String, UInt32, Int64, Int64, out Double[], out UInt16[], out Int64[])

Gets the parameter samples for specific channel. It will return the data for timestamp between start and end timestamp.

Declaration

void GetSamples(string identifier, uint channelId, long startTime, long endTime, out double[] values, out ushort[] statuses, out long[] timestamps)

Parameters

Type	Name	Description
System.String	identifier	Parameter identifier.
System.UInt32	channelId	Channel id.
System.Int64	startTime	Start timestamp for requested sample.
System.Int64	endTime	End timestamp for requested sample.
System.Double[]	values	The values.
System.UInt16[]	statuses	The statuses.
System.Int64[]	timestamps	The timestamps.