Interface IDataRequestSignalFactory

A data signal factory class. Used for creating the relevant signal for posting it on the signal bus ISignalBus.

Namespace: MAT.Atlas.Client.Platform.Data

Assembly: MAT.Atlas.Client.Platform.dll

Syntax

public interface IDataRequestSignalFactory

Methods

CreateCompositeDataRequestSignal(Guid, CompositeSessionContainerKey, IDisplayParameterContainer, TimeRange, Int32, SampleMode)

Creates a composite data request signal.

Declaration

CompositeDataRequestSignal CreateCompositeDataRequestSignal(Guid sourceId, CompositeSessionContainerKey compositeSessionContainerKey, IDisplayParameterContainer parameterContainer, TimeRange timeRange, int sampleCount, SampleMode sampleMode)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
CompositeSessionContainerKey	compositeSessionContainerKey	Composite session container key.
IDisplayParameterContainer	parameterContainer	IDisplayParameterContainer
TimeRange	timeRange	Time range of data request.
System.Int32	sampleCount	Number of samples to return. It is used to calculate the interval.
SampleMode	sampleMode	Sample mode SampleMode.

Returns

Type	Description
CompositeDataRequestSignal	Composite data request signal CompositeDataRequestSignal.

Remarks

A new request identifier will be assigned automatically.

CreateCompositeDataRequestSignal(Guid, Guid, CompositeSessionContainerKey, IDisplayParameterContainer, TimeRange, Int32, SampleMode)

Creates a composite data request signal.

Declaration

CompositeDataRequestSignal CreateCompositeDataRequestSignal(Guid sourceId, Guid requestId, CompositeSessionContainerKey compositeSessionContainerKey, IDisplayParameterContainer parameterContainer, TimeRange timeRange, int sampleCount, SampleMode sampleMode)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
System.Guid	requestId	Request identifier (user supplied identifier to link result to request).
CompositeSessionContainerKey	compositeSessionContainerKey	Composite session container key.
IDisplayParameterContainer	parameterContainer	IDisplayParameterContainer
TimeRange	timeRange	Time range of data request.
System.Int32	sampleCount	Number of samples to return. It is used to calculate the interval.
SampleMode	sampleMode	Sample mode SampleMode.

Returns

Type	Description
CompositeDataRequestSignal	Composite data request signal CompositeDataRequestSignal.

CreateCompositeSampleRequestSignal(Guid, CompositeSessionContainerKey, IDisplayParameterContainer, TimeRange, SampleDirection)

Creates a composite sample request signal.

Declaration

CompositeSampleRequestSignal CreateCompositeSampleRequestSignal(Guid sourceId, CompositeSessionContainerKey compositeSessionContainerKey, IDisplayParameterContainer parameterContainer, TimeRange timeRange, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
CompositeSessionContainerKey	compositeSessionContainerKey	Composite session container key.
IDisplayParameterContainer	parameterContainer	IDisplayParameterContainer
TimeRange	timeRange	Time range of data request.
SampleDirection	sampleDirection	Define direction for data look up.

Returns

Type	Description
CompositeSampleRequestSignal	Composite sample request signal CompositeSampleRequestSignal.

CreateCompositeSampleRequestSignal(Guid, CompositeSessionContainerKey, IDisplayParameterContainer, Int64, Int32, SampleDirection)

Creates a composite sample request signal.

Declaration

CompositeSampleRequestSignal CreateCompositeSampleRequestSignal(Guid sourceId, CompositeSessionContainerKey compositeSessionContainerKey, IDisplayParameterContainer parameterContainer, long startTime, int sampleCount, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
CompositeSessionContainerKey	compositeSessionContainerKey	Composite session container key.
IDisplayParameterContainer	parameterContainer	IDisplayParameterContainer
System.Int64	startTime	Start timestamp.
System.Int32	sampleCount	Number of samples to return.
SampleDirection	sampleDirection	Define direction for data look up.

Returns

Type	Description
CompositeSampleRequestSignal	Composite sample request signal CompositeSampleRequestSignal.

CreateCompositeSampleRequestSignal(Guid, Guid, CompositeSessionContainerKey, IDisplayParameterContainer, TimeRange, SampleDirection)

Creates a composite sample request signal.

Declaration

CompositeSampleRequestSignal CreateCompositeSampleRequestSignal(Guid sourceId, Guid requestId, CompositeSessionContainerKey compositeSessionContainerKey, IDisplayParameterContainer parameterContainer, TimeRange timeRange, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
System.Guid	requestId	Request identifier (user supplied identifier to link result to request).
CompositeSessionContainerKey	compositeSessionContainerKey	Composite session container key.
IDisplayParameterContainer	parameterContainer	IDisplayParameterContainer
TimeRange	timeRange	Time range of data request.
SampleDirection	sampleDirection	Define direction for data look up.

Returns

Type	Description
CompositeSampleRequestSignal	Composite sample request signal CompositeSampleRequestSignal.

CreateCompositeSampleRequestSignal(Guid, Guid, CompositeSessionContainerKey, IDisplayParameterContainer, Int64, Int32, SampleDirection)

Creates a composite sample request signal.

Declaration

CompositeSampleRequestSignal CreateCompositeSampleRequestSignal(Guid sourceId, Guid requestId, CompositeSessionContainerKey compositeSessionContainerKey, IDisplayParameterContainer parameterContainer, long startTime, int sampleCount, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
System.Guid	requestId	Request identifier (user supplied identifier to link result to request).
CompositeSessionContainerKey	compositeSessionContainerKey	Composite session container key.
IDisplayParameterContainer	parameterContainer	IDisplayParameterContainer
System.Int64	startTime	Start timestamp.
System.Int32	sampleCount	Number of samples to return.
SampleDirection	sampleDirection	Define direction for data look up.

Returns

Type	Description
CompositeSampleRequestSignal	Composite sample request signal CompositeSampleRequestSignal.

Remarks

A new request identifier will be assigned automatically.

CreateDataRequestSignal(Guid, IDisplayParameter, TimeRange, Int32, SampleMode)

Creates a data request signal.

Declaration

DataRequestSignal CreateDataRequestSignal(Guid sourceId, IDisplayParameter parameter, TimeRange timeRange, int sampleCount, SampleMode sampleMode)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
IDisplayParameter	parameter	Parameter IDisplayParameter requesting data for.
TimeRange	timeRange	Time range of data request.
System.Int32	sampleCount	Number of samples to return. It is used to calculate the interval.
SampleMode	sampleMode	Sample mode SampleMode.

Returns

Type	Description
DataRequestSignal	Data request signal DataRequestSignal.

CreateDataRequestSignal(Guid, Guid, IDisplayParameter, TimeRange, Int32, SampleMode)

Creates data request signal.

Declaration

DataRequestSignal CreateDataRequestSignal(Guid sourceId, Guid requestId, IDisplayParameter parameter, TimeRange timeRange, int sampleCount, SampleMode sampleMode)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
System.Guid	requestId	Request identifier (user supplied identifier to link result to request).
IDisplayParameter	parameter	Parameter IDisplayParameter requesting data for.
TimeRange	timeRange	Time range of data request.
System.Int32	sampleCount	Number of samples to return. It is used to calculate the interval.
SampleMode	sampleMode	Sample mode SampleMode.

Returns

Type	Description
DataRequestSignal	Data request signal DataRequestSignal.

CreateDataStatisticsRequestSignal(Guid, Guid, CompositeSessionContainerKey, IDisplayParameterContainer, TimeRange, ILap, StatisticLevel, StatisticOption)

Creates a statistics data request signal.

Declaration

DataStatisticsRequestSignal CreateDataStatisticsRequestSignal(Guid sourceId, Guid requestId, CompositeSessionContainerKey compositeSessionContainerKey, IDisplayParameterContainer parameterContainer, TimeRange timeRange, ILap lap, StatisticLevel statisticLevel, StatisticOption statisticOption)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
System.Guid	requestId	Request identifier (user supplied identifier to link result to request).
CompositeSessionContainerKey	compositeSessionContainerKey	Composite session container key.
IDisplayParameterContainer	parameterContainer	Parameter container IDisplayParameterContainer requesting data for.
TimeRange	timeRange	Time range of data request.
ILap	lap	The Lap.
StatisticLevel	statisticLevel	StatisticLevel
StatisticOption	statisticOption	StatisticOption

Returns

Type	Description
DataStatisticsRequestSignal	Data statistics request signal DataStatisticsRequestSignal.

CreateSampleRequestSignal(Guid, CompositeSessionKey, IDisplayParameter, TimeRange, SampleDirection)

Creates a sample request signal.

Declaration

SampleRequestSignal CreateSampleRequestSignal(Guid sourceId, CompositeSessionKey compositeSessionKey, IDisplayParameter parameter, TimeRange timeRange, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
CompositeSessionKey	compositeSessionKey	Composite session key.
IDisplayParameter	parameter	Parameter IDisplayParameter requesting data for.
TimeRange	timeRange	Time range of data request.
SampleDirection	sampleDirection	Define direction for data look up. Default value is SampleDirection.Next.

Returns

Type	Description
SampleRequestSignal	Sample request signal SampleRequestSignal.

Remarks

A new request identifier will be assigned automatically.

CreateSampleRequestSignal(Guid, CompositeSessionKey, IDisplayParameter, Int64, Int32, SampleDirection)

Creates a sample request signal.

Declaration

SampleRequestSignal CreateSampleRequestSignal(Guid sourceId, CompositeSessionKey compositeSessionKey, IDisplayParameter parameter, long startTime, int sampleCount, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
CompositeSessionKey	compositeSessionKey	Composite session key.
IDisplayParameter	parameter	Parameter IDisplayParameter requesting data for.
System.Int64	startTime	Start timestamp.
System.Int32	sampleCount	Number of samples to return.
SampleDirection	sampleDirection	Define direction for data look up.

Returns

Type	Description
SampleRequestSignal	Sample request signal SampleRequestSignal.

Remarks

A new request identifier will be assigned automatically.

CreateSampleRequestSignal(Guid, Guid, CompositeSessionKey, IDisplayParameter, TimeRange, SampleDirection)

Creates a sample request signal.

Declaration

SampleRequestSignal CreateSampleRequestSignal(Guid sourceId, Guid requestId, CompositeSessionKey compositeSessionKey, IDisplayParameter parameter, TimeRange timeRange, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
System.Guid	requestId	Request identifier (user supplied identifier to link result to request).
CompositeSessionKey	compositeSessionKey	Composite session key.
IDisplayParameter	parameter	Parameter IDisplayParameter requesting data for.
TimeRange	timeRange	Time range of data request.
SampleDirection	sampleDirection	Define direction for data look up.

Returns

Type	Description
SampleRequestSignal	Sample request signal SampleRequestSignal.

CreateSampleRequestSignal(Guid, Guid, CompositeSessionKey, IDisplayParameter, Int64, Int32, SampleDirection)

Creates a sample request signal.

Declaration

SampleRequestSignal CreateSampleRequestSignal(Guid sourceId, Guid requestId, CompositeSessionKey compositeSessionKey, IDisplayParameter parameter, long startTime, int sampleCount, SampleDirection sampleDirection)

Parameters

Type	Name	Description
System.Guid	sourceId	Signal sender identifier.
System.Guid	requestId	Request identifier (user supplied identifier to link result to request).
CompositeSessionKey	compositeSessionKey	Composite session key.
IDisplayParameter	parameter	Parameter IDisplayParameter requesting data for.
System.Int64	startTime	Start timestamp.
System.Int32	sampleCount	Number of samples moving from start time.
SampleDirection	sampleDirection	Define direction for data look up.

Returns

Type	Description
SampleRequestSignal	Sample request signal SampleRequestSignal.