Interface ISessionService
Session service.
Namespace: MAT.Atlas.Automation.Api
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
[AutomationService("Session")]
public interface ISessionService : IAutomationService
Methods
AddDataToTransientParameter(SessionId, String, Int64, Int64, Double[])
Add data to a transient parameter.
Declaration
void AddDataToTransientParameter(SessionId sessionId, string parameterIdentifier, long startTime, long interval, double[] values)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a transient parameter. |
System.Int64 | startTime | Start of time range (nanoseconds). |
System.Int64 | interval | Data interval (nanoseconds). |
System.Double[] | values | Data values. |
AddOrUpdateSessionDetail(SessionId, String, String)
Add or update a session detail.
Declaration
SessionDetail AddOrUpdateSessionDetail(SessionId sessionId, string name, string value)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | name | Name of session detail. |
System.String | value | Value of session detail. |
Returns
Type | Description |
---|---|
SessionDetail | Added or updated session detail properties. |
AddSessionEvent(SessionId, Int64, String, String, EventPriority, Boolean, Double[])
Add session event.
Declaration
void AddSessionEvent(SessionId sessionId, long timestamp, string description, string groupName, EventPriority eventPriority, bool persist, double[] rawData)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.Int64 | timestamp | Time stamp for session event. |
System.String | description | Description of session event. |
System.String | groupName | Group name of session event. |
EventPriority | eventPriority | Event priority of session event. |
System.Boolean | persist | Whether to persist the event to the session. |
System.Double[] | rawData | Raw data of the session event. |
AddTimeDataToTransientParameter(SessionId, String, Int64[], Double[])
Add data to a transient parameter.
Declaration
void AddTimeDataToTransientParameter(SessionId sessionId, string parameterIdentifier, long[] timestamps, double[] values)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a transient parameter. |
System.Int64[] | timestamps | Data timestamps. |
System.Double[] | values | Data values. |
Remarks
A time stamp per value must be provided.
AddTransientParameter(SessionId, String, String, String, String[], Double, Double)
Add transient parameter to session.
Declaration
Parameter AddTransientParameter(SessionId sessionId, string identifier, string name, string description, string[] groups, double minimum, double maximum)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | identifier | Transient parameter identifier. |
System.String | name | Name of transient parameter. |
System.String | description | Description of transient parameter. |
System.String[] | groups | Groups to add transient parameter. |
System.Double | minimum | Minimum of transient parameter. |
System.Double | maximum | Maximum of transient parameter. |
Returns
Type | Description |
---|---|
Parameter | Parameter properties. |
AppendSessions(SessionId, String[])
Append sessions to session.
Declaration
void AppendSessions(SessionId sessionId, string[] filePaths)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String[] | filePaths | Sessions to append. |
AppendSessionsWithAssociates(SessionId, String[], Int64[])
Append sessions and associated sessions to session.
Declaration
void AppendSessionsWithAssociates(SessionId sessionId, string[] filePaths, long[] versions)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String[] | filePaths | Sessions to append. |
System.Int64[] | versions | Associate session version numbers (pass 0 for defaults). |
Remarks
A version per file path must be provided.
GetCompositeSession(SessionId)
Get the properties of a composite session.
Declaration
CompositeSession GetCompositeSession(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a composite session. |
Returns
Type | Description |
---|---|
CompositeSession | Composite session properties. |
GetSession(SessionId)
Get the properties of a session.
Declaration
Session GetSession(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
Session | Session properties. |
GetSessionDetail(SessionId, String)
Get the properties of a session detail.
Declaration
SessionDetail GetSessionDetail(SessionId sessionId, string name)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | name | Unique name of a session detail. |
Returns
Type | Description |
---|---|
SessionDetail | Session detail properties. |
GetSessionDetails(SessionId)
Get the properties of all session details associated with a session.
Declaration
SessionDetail[] GetSessionDetails(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
SessionDetail[] | Collection of session detail properties. |
GetSessionEvent(SessionId, Int32)
Get the properties of a session event.
Declaration
SessionEvent GetSessionEvent(SessionId sessionId, int id)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.Int32 | id | Unique identifier of a session event. |
Returns
Type | Description |
---|---|
SessionEvent | Session event properties. |
GetSessionEvents(SessionId)
Get the properties of all session events associated with a session.
Declaration
SessionEvent[] GetSessionEvents(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
SessionEvent[] | Collection of session event properties. |
GetSessionFastestLap(SessionId)
Get the fastest lap of a session.
Declaration
Lap GetSessionFastestLap(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
Lap | Fastest lap properties. |
GetSessionLapById(SessionId, Int32)
Get a lap by Id from a session.
Declaration
Lap GetSessionLapById(SessionId sessionId, int lapId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.Int32 | lapId | Id of lap. |
Returns
Type | Description |
---|---|
Lap | Lap properties. |
GetSessionLapByNumber(SessionId, Int16)
Get a lap by number of a session. Note that the lap number is not guaranteed to be unique within a session. If not this will return the first occurrence of that lap number. See GetSessionLapById(SessionId, Int32) as the recommended approach.
Declaration
Lap GetSessionLapByNumber(SessionId sessionId, short number)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.Int16 | number | Lap number. |
Returns
Type | Description |
---|---|
Lap | Lap properties. |
GetSessionLaps(SessionId)
Get the properties of all laps associated with a session.
Declaration
Lap[] GetSessionLaps(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
Lap[] | Collection of lap properties. |
GetSessionParameter(SessionId, String)
Get the properties of a session parameter.
Declaration
Parameter GetSessionParameter(SessionId sessionId, string parameterIdentifier)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a parameter. |
Returns
Type | Description |
---|---|
Parameter | Parameter properties. |
GetSessionParameterById(SessionId, ObjectId)
Get the properties of a session parameter.
Declaration
Parameter GetSessionParameterById(SessionId sessionId, ObjectId parameterInstanceIdentifier)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
ObjectId | parameterInstanceIdentifier | Unique instance identifier of a parameter. |
Returns
Type | Description |
---|---|
Parameter | Parameter properties. |
GetSessionParameterByIndex(SessionId, Int32)
Get the properties of a session parameter.
Declaration
Parameter GetSessionParameterByIndex(SessionId sessionId, int parameterIndex)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.Int32 | parameterIndex | Index of parameter. |
Returns
Type | Description |
---|---|
Parameter | Parameter properties. |
Remarks
Range between 0 and GetSessionParameterCount(SessionId) - 1.
GetSessionParameterCount(SessionId)
Get the number of parameters within a session.
Declaration
int GetSessionParameterCount(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
System.Int32 | Session parameter count. |
GetSessionParameters(SessionId)
Get the properties of all parameters associated with a session.
Declaration
Parameter[] GetSessionParameters(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
Parameter[] | Collection of session parameter properties. |
GetSessions(SessionId)
Get the properties of all sessions associated with a composite session.
Declaration
Session[] GetSessions(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a composite session. |
Returns
Type | Description |
---|---|
Session[] | Collection of session properties. |
GetSessionTimeBase(SessionId)
Get the timebase properties of a session.
Declaration
TimeBase GetSessionTimeBase(SessionId sessionId)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
Returns
Type | Description |
---|---|
TimeBase | Timebase properties. |
RemoveDataFromTransientParameter(SessionId, String)
Remove the data associated with a transient parameter.
Declaration
void RemoveDataFromTransientParameter(SessionId sessionId, string parameterIdentifier)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a transient parameter. |
RemoveSessionDetail(SessionId, String)
Remove a session detail from a session.
Declaration
void RemoveSessionDetail(SessionId sessionId, string name)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | name | Unique name of a session detail. |
RemoveTransientParameter(SessionId, String)
Remove a transient parameter from a session.
Declaration
void RemoveTransientParameter(SessionId sessionId, string parameterIdentifier)
Parameters
Type | Name | Description |
---|---|---|
SessionId | sessionId | Unique identifier of a session. |
System.String | parameterIdentifier | Unique identifier of a transient parameter. |
SetCompareOffset(SessionId, Double)
Sets the compare offset value.
Declaration
void SetCompareOffset(SessionId compositeSessionId, double value)
Parameters
Type | Name | Description |
---|---|---|
SessionId | compositeSessionId | Unique identifier of secondary composite session. |
System.Double | value | The value. |