Interface ISessionLoader

Interface for developing a plug-in for loading file based Sessions.

Namespace: MESL.SqlRace.Domain.FileSession

Assembly: MESL.SqlRace.Domain.dll

Syntax

public interface ISessionLoader

Properties

IsPreparedForDetailsOnly

Indicate if the loader was opened for details only queries

Declaration

bool IsPreparedForDetailsOnly { get; }

Property Value

Type	Description
System.Boolean

Methods

CloseSession()

Close the underlying session adapter

Declaration

void CloseSession()

GetDataForParameter(String, Int64, Int64, Int64, Boolean)

Get data for the given parameter

Declaration

ISamplesDataResult GetDataForParameter(string parameterIdentifier, long startTime, long endTime, long sampleRate, bool interpolate)

Parameters

Type	Name	Description
System.String	parameterIdentifier	The identifier of the parameter.
System.Int64	startTime	The start time of the request.
System.Int64	endTime	The end time of the request.
System.Int64	sampleRate	The sample rate
System.Boolean	interpolate	Interpolate the data

Returns

Type	Description
ISamplesDataResult

Remarks

Implementing this function is not mandatory as it is not currently used

GetEventData()

Request Event data from the file-based Session

Declaration

IEnumerable<Event> GetEventData()

Returns

Type	Description
System.Collections.Generic.IEnumerable<Event>	A List of Event

GetEventData(Int64, Int64)

Request Event data from the file-based Session

Declaration

IEnumerable<Event> GetEventData(long startTime, long endTime)

Parameters

Type	Name	Description
System.Int64	startTime	The start time of the request.
System.Int64	endTime	The end time of the request.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Event>	A List of Event

GetNextSample(String, Int64, out Double, out Int64)

Get the next sample from the startTime provided

Declaration

DataStatusType GetNextSample(string parameterIdentifier, long startTime, out double sample, out long timestamp)

Parameters

Type	Name	Description
System.String	parameterIdentifier	The identifier of the parameter.
System.Int64	startTime	The start time of the request.
System.Double	sample	The data of the sample
System.Int64	timestamp	The timestamp of the sample

Returns

Type	Description
MAT.OCS.Core.DataStatusType	Return the status of data sample.

GetNextSamples(String, Int64, Int32)

Get the maximumNumberOfSamples for the given parameter from the start time provided going forward

Declaration

ISamplesDataResult GetNextSamples(string parameterIdentifier, long startTime, int maximumNumberOfSamples)

Parameters

Type	Name	Description
System.String	parameterIdentifier	The identifier of the parameter.
System.Int64	startTime	The start time of the request.
System.Int32	maximumNumberOfSamples	The number of samples requested.

Returns

Type	Description
ISamplesDataResult

GetPrevSample(String, Int64, out Double, out Int64)

Get the previous sample from the startTime provided

Declaration

DataStatusType GetPrevSample(string parameterIdentifier, long startTime, out double sample, out long timestamp)

Parameters

Type	Name	Description
System.String	parameterIdentifier	The identifier of the parameter.
System.Int64	startTime	The start time of the request.
System.Double	sample	The data of the sample
System.Int64	timestamp	The timestamp of the sample

Returns

Type	Description
MAT.OCS.Core.DataStatusType	Return the status of data sample.

GetPrevSamples(String, Int64, Int32)

Get the maximumNumberOfSamples for the given parameter from the start time provided going backward

Declaration

ISamplesDataResult GetPrevSamples(string parameterIdentifier, long startTime, int maximumNumberOfSamples)

Parameters

Type	Name	Description
System.String	parameterIdentifier	The identifier of the parameter.
System.Int64	startTime	The start time of the request.
System.Int32	maximumNumberOfSamples	The number of samples requested.

Returns

Type	Description
ISamplesDataResult

GetSamplesForParameter(String, Int64, Int64)

Get all the samples for the given parameter in the provided time range

Declaration

ISamplesDataResult GetSamplesForParameter(string parameterIdentifier, long startTime, long endTime)

Parameters

Type	Name	Description
System.String	parameterIdentifier	The identifier of the parameter.
System.Int64	startTime	The start time of the request.
System.Int64	endTime	The end time of the request.

Returns

Type	Description
ISamplesDataResult

GetSessionEpochDate()

Gets the session epoch date.

Declaration

Nullable<DateTime> GetSessionEpochDate()

Returns

Type	Description
System.Nullable<System.DateTime>

LoadSessionConfiguration()

Request the Session configuration to be loaded from the File based Session.

Declaration

IEnumerable<ISessionConfiguration> LoadSessionConfiguration()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISessionConfiguration>	A ISessionConfiguration containing the relevant Session configuration.

LoadSessionInformation()

Request the Session information to be loaded from the File based Session.

Declaration

ISessionInformation LoadSessionInformation()

Returns

Type	Description
ISessionInformation	A ISessionInformation containing the relevant Session information.

PrepareFileForLoadingSessionInformationAndConfiguration(String, Boolean)

Prepare the file for quick loading of the Session information and for the slow loading of the Session configuration.

Declaration

bool PrepareFileForLoadingSessionInformationAndConfiguration(string filePath, bool detailsOnly)

Parameters

Type	Name	Description
System.String	filePath	The path to the file to open. This file should be shared bewteen the load information call and the load configuration call.
System.Boolean	detailsOnly	Load only details of the session.

Returns

Type	Description
System.Boolean	True when the file is prepared, otherwise false.

PrepareFileForRetrievingData(String)

Prepare the file for being requested for data for parameters within the file.

Declaration

bool PrepareFileForRetrievingData(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path to the file to open.

Returns

Type	Description
System.Boolean	True when the file is prepared, otherwise false.

UpdateSessionDetail(String, String)

Add or updates a session detail.

Declaration

void UpdateSessionDetail(string detailName, string detailValue)

Parameters

Type	Name	Description
System.String	detailName	Name of the detail.
System.String	detailValue	The detail value.

Events

OnFileSessionConfigurationAvailableEvent

Indicates that configuaration is available and ready.

Declaration

event EventHandler<FileSessionConfigurationAvailableEventArgs> OnFileSessionConfigurationAvailableEvent

Event Type

Type	Description
System.EventHandler<FileSessionConfigurationAvailableEventArgs>

OnFileSessionConfigurationLoadedEvent

Indicates that configuration has been loaded from the underlying file session.

Declaration

event EventHandler<FileSessionConfigurationLoadedEventArgs> OnFileSessionConfigurationLoadedEvent

Event Type

Type	Description
System.EventHandler<FileSessionConfigurationLoadedEventArgs>

OnFileSessionFileLoadedEvent

Indicates that the underlying file has been loaded

Declaration

event EventHandler<FileSessionFileLoadedEventArgs> OnFileSessionFileLoadedEvent

Event Type

Type	Description
System.EventHandler<FileSessionFileLoadedEventArgs>