Interface ICompositeSessionContainer

Interface representing a CompositeSessionContainer

Namespace: MESL.SqlRace.Domain

Assembly: MESL.SqlRace.Domain.dll

Syntax

public interface ICompositeSessionContainer : IDisposable

Properties

CompositeSessions

Gets the list of CompositeSessions

Declaration

IReadOnlyList<ICompositeSession> CompositeSessions { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<ICompositeSession>

Disposed

Has this instance been Disposed

Declaration

bool Disposed { get; }

Property Value

Type	Description
System.Boolean

Identifier

Composite Session Container Identifier

Declaration

string Identifier { get; set; }

Property Value

Type	Description
System.String

Key

Composite Session Container Key

Declaration

CompositeSessionContainerKey Key { get; set; }

Property Value

Type	Description
MAT.OCS.Core.CompositeSessionContainerKey

PrimaryCompositeSession

Gets the CompositeSession in the Primary Slot

Declaration

ICompositeSession PrimaryCompositeSession { get; }

Property Value

Type	Description
ICompositeSession

XAxisParameter

Gets or Sets the X Axis Parameter for Container

Declaration

string XAxisParameter { get; }

Property Value

Type	Description
System.String

Methods

Add(ICompositeSession)

Add a CompositeSession instance to this Container

Declaration

void Add(ICompositeSession compositeSession)

Parameters

Type	Name	Description
ICompositeSession	compositeSession	CompositeSession to be Added

Add(List<ICompositeSession>)

Add a list of CompositeSessions

Declaration

void Add(List<ICompositeSession> compositeSessions)

Parameters

Type	Name	Description
System.Collections.Generic.List<ICompositeSession>	compositeSessions

CreateParameterDataAccess(String)

Creates the parameter data access.

Declaration

ICompositeContainerParameterDataAccess CreateParameterDataAccess(string identifier)

Parameters

Type	Name	Description
System.String	identifier	The parameter identifier.

Returns

Type	Description
ICompositeContainerParameterDataAccess

PromoteToPrimary(CompositeSessionKey)

Promote CompositeSession to the Primary Slot

Declaration

ICompositeSession PromoteToPrimary(CompositeSessionKey key)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key

Returns

Type	Description
ICompositeSession

Remove(CompositeSessionKey)

Remove a CompositeSession

Declaration

void Remove(CompositeSessionKey key)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	Key of Session to Remove.

Remove(List<CompositeSessionKey>)

Remove a list of CompositeSessions

Declaration

void Remove(List<CompositeSessionKey> keys)

Parameters

Type	Name	Description
System.Collections.Generic.List<MAT.OCS.Core.CompositeSessionKey>	keys

Exceptions

Type	Condition
System.NotImplementedException

SetAutoFitLaps(CompositeSessionKey, Boolean)

Sets AutoFitLaps on or off

Declaration

void SetAutoFitLaps(CompositeSessionKey key, bool autoFit)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	Composite Session Key to set auto fit to
System.Boolean	autoFit	boolean

SetAutoFitLaps(Boolean)

Sets AutoFitLaps on or off

Declaration

void SetAutoFitLaps(bool autoFit)

Parameters

Type	Name	Description
System.Boolean	autoFit	boolean

SetAutoFitLimit(CompositeSessionKey, Double)

Sets the AutoFit Limit

Declaration

void SetAutoFitLimit(CompositeSessionKey key, double autoFitLimit)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	Composite Session Key to apply auto fit limit to
System.Double	autoFitLimit	% Threshold below which data will be stretched or compressed

Remarks

The X-axis of the Overlay data is stretched or compressed so that the start and end of each lap matches the start and end of the lap in the primary set

SetAutoFitLimit(Double)

Sets the AutoFit Limit

Declaration

void SetAutoFitLimit(double autoFitLimit)

Parameters

Type	Name	Description
System.Double	autoFitLimit	% Threshold below which data will be stretched or compressed

Remarks

The X-axis of the Overlay data is stretched or compressed so that the start and end of each lap matches the start and end of the lap in the primary set

SetOffsetValue(CompositeSessionKey, Double)

Sets an X Axis offset value for a slave session.

Declaration

void SetOffsetValue(CompositeSessionKey key, double offset)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	The key.
System.Double	offset	The offset.

SetOffsetValue(CompositeSessionKey, Int64)

Sets a Time offset value for a slave session.

Declaration

void SetOffsetValue(CompositeSessionKey key, long offset)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	The Composite Session key.
System.Int64	offset	The offset value.

SetOffsetValue(Double)

Sets the X Axis Offset value for all Slave Sessions.

Declaration

void SetOffsetValue(double offset)

Parameters

Type	Name	Description
System.Double	offset	The offset.

SetOffsetValue(Int64)

Sets the time Offset value for all Slave Sessions.

Declaration

void SetOffsetValue(long offset)

Parameters

Type	Name	Description
System.Int64	offset	The offset.

SetSessionCompareMode(CompositeSessionKey, SessionCompareMode, SessionKey, Nullable<Int32>)

Set the compare mode on a particular session in the container.

Declaration

void SetSessionCompareMode(CompositeSessionKey compositeSessionKey, SessionCompareMode compareMode, SessionKey sessionKey, Nullable<int> lapId = null)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	compositeSessionKey	The key of the session you wish to change.
SessionCompareMode	compareMode	The mode that the session will be compared with.
MAT.OCS.Core.SessionKey	sessionKey	When lapId populated, pass the session key of the session that the lap belongs to
System.Nullable<System.Int32>	lapId	The lap Id required for Single Lap Repeat mode, otherwise not required

SetXAxisParameter(String)

Sets the x axis parameter.

Declaration

void SetXAxisParameter(string identifier)

Parameters

Type	Name	Description
System.String	identifier	The identifier.