Namespace MESL.SqlRace.Domain

Classes

AddCanDataErrorEventArgs

Represents an Event raised when there has been an error adding CAN data to a Session

ApplicationGroup

Used as the highest level container for a Parameter.

AsyncEventArgs

Contains information about an event generated during asynchronous (background) processing

Channel

Represents a channel which defines the type and frequency at which data is stored in SQL Race.

ChannelBasedParameter

An abstract base class for parameters based on channels.

CompositeContainerParameterDataAccess

A composite container parameter data access object.

CompositeMinimumMaximumMeanSample

Min Max Mean Composite Sample

CompositeParameterDataAccess

A composite parameter data access object.

CompositePdaParallelExecutionService

Execute Action for Composite PDA

ConfigurationCommittedException

ConfigurationSetAlreadyExistsException

ConfigurationSet

ConfigurationSetManager

Responsible for creating, deleting and checking for the existence of configuration sets.

ConnectionInformationBase

Base class for a connection. DatabaseConnectionInformation RemoteConnectionInformation

ConnectionStringParser

Utility class for connection string parsing.

Constant

To support the addition of constants in session and lap item collections

ConstantParameterDataAccess

PDA for accessing constants on the session or lap. See ParameterDataAccessBase documentation for more information.

ConversionBase

Base class for the different conversion types available to associate with data for a parameter or event.

Core

Provides methods to initialize SQL Race and change settings such as logging level and cache size.

CoreInitialisedEventArgs

The event raised when the core gets initialized

DatabaseConnectionManager

Maintains a cache of database connection contexts

DataItem

Represents a DataItem. This is simply a name/value pair of strings.

DataItemReader

Responsible for retrieving data items across all sessions in SQL Race.

DbConfiguration

The information for a database configuration

EntityBase

Base class for entities associated with a session.

ErrorDefinition

Contains information for an error definition.

EventDefinition

This class encapsulates metadata for an event definition.

ExtendedAssociate

It represents an entity of Identity information of an associated session

FastConfigurationSetAttributes

Describes FFC resources.

FileSessionManager

Class for the management of finding file based sessions contained on the file system for indexing as SQL Race Sessions.

FileSessionWatcher

Create file system watchers for SSN siles

FunctionConstants

Constants associated with the functions aspect of SQL Race

FunctionParameter

Implementation of a function parameter TODO: Possibly split this into two parameters - some types of function parameter don't require channels

LapBilinearMap

A LapBilinearMap is a type of BilinearMap that can be attached to a specific lap within a session.

LapDataItem

This class represents the contents of a data item that can be attached to a lap

LapLinearMap

A LapLinearMap is a type of LinearMap that can be attached to a specific lap within a session.

LapMapBase

Provides the abstract base class for the LapMap object.

LapStatisticsEventArgs

Contains details about the lap statistics that were calculated.

MapBase

Represents the base class for all map types.

MinimumMaximumMeanDouble

Represents a minimum, maximun and mean value.

ParameterDataAccess

This is used to defines how data is sampled or interpolated and obtained from SQL Race. ParameterDataAccessBase

ParameterDataAccessBase

This is used to defines how data is sampled or interpolated and obtained from SQL Race.

The ParameterDataAccess and RemoteParameterDataAccess object is created by calling the Session.CreateParameterDataAccess(parameterIdentifier) method and is associated with both the session and a Parameter. More than one ParameterDataAccess object can exist within a session as each can used to retrieve the parameter data.

A ParameterDataAccess object can be created to retrieve data from all the Channel within Parameter or for data from specific Channel.

Methods on the ParameterDataAccess object allow you to:

Move to specific point in time
Set the sample time
Read subsampled data
Read interpolated data
Read the actual sample values

Follow the below best practices:

Opening a PDA uses up memory until the session is closed and disposed. It is best to open a PDA for a parameter once and cache it. Then you can reuse it throughout the session. An example of when this is particularly useful is when iterating through laps. It is better to open each PDA once than to open and dispose of them inside the lap iteration.
Calls to a PDA are not thread safe. If you are wanting to access data using the same Parameter in different threads, it is better to consider opening a small pool of PDAs for the threads to use. You have to be extra careful when using method that require the PDA's current position to ensure that it is only being used by one thread.

The following code snippet shows an example of using the ParameterDataAccess class to read subsampled data across all channels for a parameter:

  // Local database connection string and session key for data already recorded
  string connectionString = @"Data Source=.\sqlexpress;Initial Catalog=SQLRACE01;Integrated Security=SSPI";
  SessionKey sessionKey = new Guid("7DD05707-EAA2-4A36-BB8A-E2327AA52BFC");

  // Initialise
  Core.Initialize();
  SessionManager sessionManager = SessionManager.CreateSessionManager();

  // Create storage for output values
  double[] data = new double[10];
  DataStatusType[] status = new DataStatusType[10];

  // Load existing session
  Session session = sessionManager.Load(sessionKey, connectionString);

  // Use PDA to get subsampled data across all channels in parameter: ParameterId
  using(ParameterDataAccessBase pda = session.CreateParameterDataAccess("ParameterId"))
  {
       // Go to 0:00:01am
       pda.GoTo(1000000000);

       // Set sample time to 500Hz ~ 2000000ns 
       pda.SampleTime = 2000000;

       // Get 10 samples, use first sample, do not interpolate
       var parameterValues = pda.GetNextData(10, SampleModeType.First);

       // Print data and status to console window
       for (int i = 0; i < 10; i++)
       {
            Console.WriteLine("Data: {0}, Status: {1}", parameterValues.Data[i], parameterValues.DataStatus[i]); 
       }
  } 
  // Always close the session
  session.Close();

Simple example of opening a PDA setting the read cursor to the start of the session and reading the first 1000 samples. Then disposing the pda.

using (var pda = session.CreateParameterDataAccess(parameterIdentifer))
{
   pda.GoTo(session.StartTime);
   var samples = pda.GetNextData(1000);
}

An example of using a PDA cache to reuse pdas to the access data of one session and then closing the session

 // Open and cache PDA
 ParameterDataAccessBase pda;
 if (pdaCache.ContainsKey(parameterIdentifer))
 {
     pda = pdaCache[parameterIdentifer];
 }
 else
 {
     pda = session.CreateParameterDataAccess(parameterIdentifer);
     pdaCache[parameterIdentifer] = pda;
 }

 ... Do work using PDA ...

 // Before disposing of the session we want to remember to dispose the pdas openned.
 foreach (var parameterDataAccessBase in pdaCache)
 {
     parameterDataAccessBase.Value.Dispose();
 }

Namespace MESL.SqlRace.Domain

Classes

Interfaces