Interface ISessionWriter

Interface class contains the signatures of properties and functions to write the data into session. No operation can be called after CloseSession() is called.

Inherited Members

ISessionBuilder.AddGroup(Group)

ISessionBuilder.AddParameter(Parameter)

ISessionBuilder.BuildTextParameter(String, String)

ISessionBuilder.BuildRationalParameter(String, String, Range)

ISessionBuilder.CommitParameters()

ISessionBuilder.Committed

ISessionBuilder.NextChannelNumber

System.IDisposable.Dispose()

Namespace: MAT.AtlasSessionApi

Assembly: MAT.AtlasSessionApi.dll

Syntax

public interface ISessionWriter : ISessionBuilder, IDisposable

Properties

Channels

Gets the collection of key/value pairs for the channels where key is defined as channel id.

Declaration

IReadOnlyDictionary<uint, Channel> Channels { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.UInt32, Channel>

Conversions

Gets the collection of key/value pairs for the conversions where key is defined as conversion identifier.

Declaration

IReadOnlyDictionary<string, Conversion> Conversions { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, Conversion>

Groups

Collection of groups and subgroups of the parameter.

Declaration

IReadOnlyCollection<Group> Groups { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Group>

Laps

Gets the collection of laps and their description like lap number, type and start/end time of lap.

Declaration

IReadOnlyCollection<Lap> Laps { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Lap>

Parameters

Gets the collection of parameters and their descriptions.

Declaration

IEnumerable<Parameter> Parameters { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Parameter>

ParametersByIdentifier

Gets the collection of key/value pairs for the parameters where key is defined as parameter identifier.

Declaration

IReadOnlyDictionary<string, Parameter> ParametersByIdentifier { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, Parameter>

SessionItems

Gets the collection of key/value pairs for the session details.

Declaration

IReadOnlyDictionary<string, string> SessionItems { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>

Methods

AddLap(Int32, Int64, LapType)

Add a new lap into session.

Declaration

void AddLap(int number, long time, LapType type)

Parameters

Type	Name	Description
System.Int32	number	lap number.
System.Int64	time	lap timestamp.
LapType	type	type of the lap.

AddSessionDetails(String, String)

Add a new session details into session.

Declaration

void AddSessionDetails(string name, string value)

Parameters

Type	Name	Description
System.String	name	detail name.
System.String	value	detail value.

CloseSession(String)

Close the session and generate historic session file. Once closed information can't be modified. It destroy the session writer object.

Declaration

void CloseSession(string extension = "ssn")

Parameters

Type	Name	Description
System.String	extension	Close the session with extension, default is ssn. Pass ssv for associated session.

WritePeriodicData(Channel, Int64, Int32, Byte[])

Write the data into session for a given channel. The data can be passed as byte array and number of samples along with first sample timestamp.

Declaration

void WritePeriodicData(Channel channel, long timestamp, int count, byte[] data)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.Int32	count	sample count.
System.Byte[]	data	byte array of samples.

WritePeriodicValues(Channel, Int64, Byte[], Int32, ByteOrder)

Write the data into session for a given channel. The data can be passed as byte array along with first sample timestamp.

Declaration

void WritePeriodicValues(Channel channel, long timestamp, byte[] values, int count, ByteOrder byteOrder = ByteOrder.LittleEndian)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.Byte[]	values	byte array of samples.
System.Int32	count	sample count.
ByteOrder	byteOrder	byte order for little/big endian. Default is little endian

WritePeriodicValues(Channel, Int64, Int16[], Int32, ByteOrder)

Write the data into session for a given channel. The data can be passed as short array along with first sample timestamp.

Declaration

void WritePeriodicValues(Channel channel, long timestamp, short[] values, int count, ByteOrder byteOrder = ByteOrder.LittleEndian)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.Int16[]	values	short array of samples.
System.Int32	count	sample count.
ByteOrder	byteOrder	byte order for little/big endian. Default is little endian

WritePeriodicValues(Channel, Int64, Int32[], Int32, ByteOrder)

Write the data into session for a given channel. The data can be passed as integer array along with first sample timestamp.

Declaration

void WritePeriodicValues(Channel channel, long timestamp, int[] values, int count, ByteOrder byteOrder = ByteOrder.LittleEndian)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.Int32[]	values	integer array of samples.
System.Int32	count	sample count.
ByteOrder	byteOrder	byte order for little/big endian. Default is little endian

WritePeriodicValues(Channel, Int64, SByte[], Int32, ByteOrder)

Write the data into session for a given channel. The data can be passed as signed byte array along with first sample timestamp.

Declaration

void WritePeriodicValues(Channel channel, long timestamp, sbyte[] values, int count, ByteOrder byteOrder = ByteOrder.LittleEndian)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.SByte[]	values	signed byte array of samples.
System.Int32	count	sample count.
ByteOrder	byteOrder	byte order for little/big endian. Default is little endian

WritePeriodicValues(Channel, Int64, Single[], Int32, ByteOrder)

Write the data into session for a given channel. The data can be passed as float array along with first sample timestamp.

Declaration

void WritePeriodicValues(Channel channel, long timestamp, float[] values, int count, ByteOrder byteOrder = ByteOrder.LittleEndian)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.Single[]	values	float array of samples.
System.Int32	count	sample count.
ByteOrder	byteOrder	byte order for little/big endian. Default is little endian

WritePeriodicValues(Channel, Int64, UInt16[], Int32, ByteOrder)

Write the data into session for a given channel. The data can be passed as unsigned short array along with first sample timestamp.

Declaration

void WritePeriodicValues(Channel channel, long timestamp, ushort[] values, int count, ByteOrder byteOrder = ByteOrder.LittleEndian)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.UInt16[]	values	unsigned short array of samples.
System.Int32	count	sample count.
ByteOrder	byteOrder	byte order for little/big endian. Default is little endian

WritePeriodicValues(Channel, Int64, UInt32[], Int32, ByteOrder)

Write the data into session for a given channel. The data can be passed as unsigned integer array along with first sample timestamp.

Declaration

void WritePeriodicValues(Channel channel, long timestamp, uint[] values, int count, ByteOrder byteOrder = ByteOrder.LittleEndian)

Parameters

Type	Name	Description
Channel	channel	channel object.
System.Int64	timestamp	timestamp of first sample.
System.UInt32[]	values	unsigned integer array of samples.
System.Int32	count	sample count.
ByteOrder	byteOrder	byte order for little/big endian. Default is little endian