Class PortrayalTime

Namespace

EncDotNet.S100.Pipelines.Vector

Assembly

EncDotNet.S100.Core.dll

The time a map shows, for drawing instructions that are only valid at some times: one instant, or a range when the mariner views a period (S-98 §12.8.1). Dates and times without an offset are read in Zone.

public sealed record PortrayalTime : IEquatable<PortrayalTime>

Inheritance

object

PortrayalTime

Implements

IEquatable<PortrayalTime>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PortrayalTime(DateTimeOffset, DateTimeOffset, TimeZoneInfo)

The time a map shows, for drawing instructions that are only valid at some times: one instant, or a range when the mariner views a period (S-98 §12.8.1). Dates and times without an offset are read in Zone.

public PortrayalTime(DateTimeOffset Start, DateTimeOffset End, TimeZoneInfo Zone)

Parameters

Start DateTimeOffset

The view time, or the start of the viewed range.

End DateTimeOffset

The end of the viewed range; Start for one instant.

Zone TimeZoneInfo

The time zone calendar dates and times of day are read in. A host passes the zone it shows times in (the machine's zone or UTC), never the local time of the chart.

Properties

End

The end of the viewed range; Start for one instant.

public DateTimeOffset End { get; init; }

Property Value

DateTimeOffset

Start

The view time, or the start of the viewed range.

public DateTimeOffset Start { get; init; }

Property Value

DateTimeOffset

Zone

The time zone calendar dates and times of day are read in. A host passes the zone it shows times in (the machine's zone or UTC), never the local time of the chart.

public TimeZoneInfo Zone { get; init; }

Property Value

TimeZoneInfo

Methods

At(DateTimeOffset, TimeZoneInfo?)

One instant, with dates read in zone (UTC when null).

public static PortrayalTime At(DateTimeOffset time, TimeZoneInfo? zone = null)

Parameters

time DateTimeOffset

The view time.

zone TimeZoneInfo

The time zone dates are read in.

Returns

PortrayalTime

The portrayal time.

Between(DateTimeOffset, DateTimeOffset, TimeZoneInfo?)

A viewed range, with dates read in zone (UTC when null).

public static PortrayalTime Between(DateTimeOffset start, DateTimeOffset end, TimeZoneInfo? zone = null)

Parameters

start DateTimeOffset

The start of the range.

end DateTimeOffset

The end of the range; swapped with start when earlier.

zone TimeZoneInfo

The time zone dates are read in.

Returns

PortrayalTime

The portrayal time.