Class CompositeSessionContainer

CompositeSessionContainer

Inheritance

System.Object

CompositeSessionContainer

Implements

ICompositeSessionContainer

System.IDisposable

Namespace: MESL.SqlRace.Domain

Assembly: MESL.SqlRace.Domain.dll

Syntax

public class CompositeSessionContainer : Object, ICompositeSessionContainer, IDisposable

Constructors

CompositeSessionContainer()

Initializes a new instance of the CompositeSessionContainer class.

Declaration

public CompositeSessionContainer()

CompositeSessionContainer(CompositeSessionContainerKey, String)

Initializes a new instance of the CompositeSessionContainer class.

Declaration

public CompositeSessionContainer(CompositeSessionContainerKey key, string identifier)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionContainerKey	key	The key.
System.String	identifier	The identifier.

CompositeSessionContainer(CompositeSessionContainerKey, String, List<ICompositeSession>)

Initializes a new instance of the CompositeSessionContainer class.

Declaration

public CompositeSessionContainer(CompositeSessionContainerKey key, string identifier, List<ICompositeSession> compositeSessions)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionContainerKey	key	The key.
System.String	identifier	The identifier.
System.Collections.Generic.List<ICompositeSession>	compositeSessions	The composite sessions.

Fields

DefaultAutoFitLapThreshold

% Threshold below which data will be stretched or compressed

Declaration

public const int DefaultAutoFitLapThreshold = 5

Field Value

Type	Description
System.Int32

Properties

CompositeSessions

Gets the System.Collections.Generic.List<> of ICompositeSession

Declaration

public IReadOnlyList<ICompositeSession> CompositeSessions { get; }

Property Value

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

Disposed

Has this instance been Disposed

Declaration

public bool Disposed { get; }

Property Value

Type	Description
System.Boolean

Identifier

Composite Session Container Identifier

Declaration

public string Identifier { get; set; }

Property Value

Type	Description
System.String

Key

Gets or Sets the MAT.OCS.Core.CompositeSessionContainerKey

Declaration

public CompositeSessionContainerKey Key { get; set; }

Property Value

Type	Description
MAT.OCS.Core.CompositeSessionContainerKey

PrimaryCompositeSession

Gets the ICompositeSession in the Primary Slot

Declaration

public ICompositeSession PrimaryCompositeSession { get; }

Property Value

Type	Description
ICompositeSession

XAxisParameter

Gets or Sets the X Axis Parameter for Container

Declaration

public string XAxisParameter { get; }

Property Value

Type	Description
System.String

Methods

Add(ICompositeSession)

Add a ICompositeSession instance to this Container

Declaration

public void Add(ICompositeSession compositeSession)

Parameters

Type	Name	Description
ICompositeSession	compositeSession	CompositeSession to be Added

Add(List<ICompositeSession>)

Add a System.Collections.Generic.List<> of ICompositeSession

Declaration

public void Add(List<ICompositeSession> compositeSessions)

Parameters

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

CreateParameterDataAccess(IDictionary<CompositeSessionKey, String>, String)

Creates an ICompositeContainerParameterDataAccess on this ICompositeSessionContainer.

Declaration

public ICompositeContainerParameterDataAccess CreateParameterDataAccess(IDictionary<CompositeSessionKey, string> parameterIdentifiers, string parameterIdentifiersList)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<MAT.OCS.Core.CompositeSessionKey, System.String>	parameterIdentifiers	The parameter identifiers.
System.String	parameterIdentifiersList	An unique identifier to identify the parameter list. Usually p1|p2|...

Returns

Type	Description
ICompositeContainerParameterDataAccess	ICompositeContainerParameterDataAccessReturns null if there is some exception.

CreateParameterDataAccess(String)

Creates an ICompositeContainerParameterDataAccess on this ICompositeSessionContainer.

Declaration

public ICompositeContainerParameterDataAccess CreateParameterDataAccess(string identifier)

Parameters

Type	Name	Description
System.String	identifier	The parameter identifier.

Returns

Type	Description
ICompositeContainerParameterDataAccess	ICompositeContainerParameterDataAccessReturns null if there is some exception.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Finalize()

Finalizer

Declaration

protected override void Finalize()

PromoteToPrimary(CompositeSessionKey)

Promotes an ICompositeSession to the Primary Slot

Declaration

public ICompositeSession PromoteToPrimary(CompositeSessionKey key)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	MAT.OCS.Core.CompositeSessionKey of the ICompositeSession to promote

Returns

Type	Description
ICompositeSession

Remove(CompositeSessionKey)

Remove an ICompositeSession

Declaration

public void Remove(CompositeSessionKey key)

Parameters

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

Remove(List<CompositeSessionKey>)

Remove a list of CompositeSessions

Declaration

public void Remove(List<CompositeSessionKey> keys)

Parameters

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

SetAutoFitLaps(CompositeSessionKey, Boolean)

Enables or Disables Autofit on the underlying ICompositeSession

Declaration

public void SetAutoFitLaps(CompositeSessionKey key, bool autoFit)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	MAT.OCS.Core.CompositeSessionKey to Enable/Disable Autofit on
System.Boolean	autoFit	boolean

SetAutoFitLaps(Boolean)

Enables or Disables Autofit on all underlying ICompositeSession

Declaration

public void SetAutoFitLaps(bool autoFit)

Parameters

Type	Name	Description
System.Boolean	autoFit	true to Enable, false to Disable

SetAutoFitLimit(CompositeSessionKey, Double)

Sets the AutoFit % Threshold on the underlying ICompositeSession

Declaration

public void SetAutoFitLimit(CompositeSessionKey key, double autoFitLimit)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	MAT.OCS.Core.CompositeSessionKey to applt the AutofitLimit 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 % Threshold on all underlying ICompositeSession

Declaration

public 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

SetEnabled(CompositeSessionKey, Boolean)

Set a composite session enabled state. Primary cannot be enabled/disabled, it is enabled by default

Declaration

public void SetEnabled(CompositeSessionKey key, bool enabled)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	MAT.OCS.Core.CompositeSessionKey to Enable/Disable Autofit on
System.Boolean	enabled	The enavbled state

SetOffsetValue(CompositeSessionKey, Double)

Sets an X Axis offset value for a slave ICompositeSession.

Declaration

public void SetOffsetValue(CompositeSessionKey key, double offset)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	The MAT.OCS.Core.CompositeSessionKey to set the offset on.
System.Double	offset	The offset value.

SetOffsetValue(CompositeSessionKey, Int64)

Sets a Time offset value for a slave session.

Declaration

public void SetOffsetValue(CompositeSessionKey key, long offset)

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	key	The MAT.OCS.Core.CompositeSessionKey to apply the offset to.
System.Int64	offset	The offset value.

SetOffsetValue(Double)

Sets the X Axis Offset value for all Slave Sessions.

Declaration

public 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

public void SetOffsetValue(long offset)

Parameters

Type	Name	Description
System.Int64	offset	The offset value.

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

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

Declaration

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

Parameters

Type	Name	Description
MAT.OCS.Core.CompositeSessionKey	sessionKey	The MAT.OCS.Core.CompositeSessionKey of the ICompositeSession you wish to change.
SessionCompareMode	compareMode	The SessionCompareMode that the session will be compared with.
MAT.OCS.Core.SessionKey	lapSessionKey	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

public void SetXAxisParameter(string identifier)

Parameters

Type	Name	Description
System.String	identifier	The identifier.

Implements

ICompositeSessionContainer

System.IDisposable