Class Marker

Represents a marker.

Inheritance

System.Object

EntityBase

Marker

Namespace: MESL.SqlRace.Domain

Assembly: MESL.SqlRace.Domain.dll

Syntax

public class Marker : EntityBase

Remarks

A marker allows a time range in a session to be defined and annotated.

Constructors

Marker(Int64, String)

Initialises a new instance of the Marker class.

Declaration

public Marker(long startTimestamp, string label)

Parameters

Type	Name	Description
System.Int64	startTimestamp	The timestamp.
System.String	label	The label.

Marker(Int64, String, String, String)

Initialises a new instance of the Marker class to indicate a single point in time.

Declaration

public Marker(long startTimestamp, string label, string description, string markerType)

Parameters

Type	Name	Description
System.Int64	startTimestamp	The timestamp.
System.String	label	The label.
System.String	description	The description.
System.String	markerType	Type of the marker.

Marker(Nullable<Int64>, Nullable<Int64>, String, String, String, String)

Initialises a new instance of the Marker class to indicate a time range.

Declaration

public Marker(Nullable<long> startTimestamp, Nullable<long> endTimestamp, string label, string markerType, string description, string guid = null)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	startTimestamp	The timestamp for the start of the range or null to use the start of the session.
System.Nullable<System.Int64>	endTimestamp	The timestamp for the end of the range or null to use the end of the session.
System.String	label	A short human readable label for the Marker, this is required.
System.String	markerType	A string defining the category that this Marker represents, this is required.
System.String	description	An optional description of what the Marker represents.
System.String	guid	The string representation of GUID for the marker or null.

Exceptions

Type	Condition
System.ArgumentException

Fields

DefaultMarkerType

The default type for the Marker if no value is explicitly provided.

Declaration

public const string DefaultMarkerType = "MARKER"

Field Value

Type	Description
System.String

Properties

Description

Gets the description.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

EndTimestamp

Gets the end timestamp

Declaration

public Nullable<long> EndTimestamp { get; }

Property Value

Type	Description
System.Nullable<System.Int64>

IsTransient

Gets the value of IsTransient property; sets it privately

Declaration

public bool IsTransient { get; }

Property Value

Type	Description
System.Boolean

Label

Gets the label of the marker.

Declaration

public string Label { get; }

Property Value

Type	Description
System.String

MarkerGuid

Gets the GUID of the marker.

Declaration

public Guid MarkerGuid { get; }

Property Value

Type	Description
System.Guid

MarkerType

Gets the type of the marker.

Declaration

public string MarkerType { get; }

Property Value

Type	Description
System.String

Properties

Gets an immutable copy of the properties.

Declaration

public ImmutableList<MarkerLabel> Properties { get; }

Property Value

Type	Description
System.Collections.Immutable.ImmutableList<MarkerLabel>

StartTimestamp

Gets the start timestamp.

Declaration

public Nullable<long> StartTimestamp { get; }

Property Value

Type	Description
System.Nullable<System.Int64>

Methods

AddLabel(MarkerLabel)

Add a descriptive label to this Marker.

Declaration

public void AddLabel(MarkerLabel label)

Parameters

Type	Name	Description
MarkerLabel	label	The label to add.

CreateTransientMarker(Nullable<Int64>, Nullable<Int64>, String, String, String, String)

Creates a new instance of the Marker class to create Transient Marker

Declaration

public static Marker CreateTransientMarker(Nullable<long> startTimestamp, Nullable<long> endTimestamp, string label, string markerType, string description, string guid = null)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	startTimestamp
System.Nullable<System.Int64>	endTimestamp
System.String	label
System.String	markerType
System.String	description
System.String	guid

Returns

Type	Description
Marker

ToString()

Returns a System.String that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

ToStringWithTransient()

Returns a System.String that represents this instance which includes the value of IsTransient.

Declaration

public string ToStringWithTransient()

Returns

Type	Description
System.String	A System.String that represents this instance.