C# Class ELTE.AEGIS.Temporal.Reference.Clock

Represents a clock.

Inheritance: ELTE.AEGIS.Temporal.Reference.TemporalReferenceSystem

Show file Open project: AegisSpatial/aegis-origin Class Usage Examples

Public Methods

Method	Description
Clock ( String identifier, String name, ELTE.AEGIS.Temporal.Reference.Calendar basis, Duration offset ) : System	Initializes a new instance of the Clock class.
Clock ( String identifier, String name, String remarks, Array aliases, String scope, ELTE.AEGIS.Temporal.Reference.Calendar basis, String referenceEvent, Instant referenceInstant, Duration offset ) : System	Initializes a new instance of the Clock class.
FromTimeZone ( ELTE.AEGIS.Temporal.Reference.TimeZone timeZone, Boolean isDaylightSaving ) : Clock	Create a clock from a time zone.
GetHour ( Instant instant ) : Int32	Returns the hours for an instant.
GetHours ( Duration duration ) : Int32	Returns the hours for a duration.
GetInstant ( Int32 hours, Int32 minutes, Int32 seconds ) : Instant	Returns the instant for the specified time.
GetInstant ( Int32 hours, Int32 minutes, Int32 seconds, Int32 milliseconds ) : Instant	Returns the instant for the specified time.
GetMilliseconds ( Duration duration ) : Int32	Returns the milliseconds within a second for a duration.
GetMilliseconds ( Instant instant ) : Int32	Returns the milliseconds within a second for an instant.
GetMinute ( Instant instant ) : Int32	Returns the minutes within an hour for an instant.
GetMinutes ( Duration duration ) : Int32	Returns the minutes within an hour for a duration.
GetSecond ( Instant instant ) : Int32	Returns the seconds within a minute for an instant.
GetSeconds ( Duration duration ) : Int32	Returns the seconds within a minute for a duration.
GetTime ( Instant instant ) : ClockTime	Returns the clock time for an instant.
GetTotalMilliseconds ( Duration duration ) : Int32	Returns the total number of milliseconds for a duration.
GetTotalMilliseconds ( Instant instant ) : Int32	Returns the total number of milliseconds for an instant.
GetTotalMinutes ( Duration duration ) : Int32	Returns the total number of minutes for a duration.
GetTotalMinutes ( Instant instant ) : Int32	Returns the total number of minutes for an instant.
GetTotalSeconds ( Duration duration ) : Int32	Returns the total number of seconds for a duration.
GetTotalSeconds ( Instant instant ) : Int32	Returns the total number of seconds for an instant.
TransformToClockTime ( ClockTime utcTime ) : ClockTime	Returns the clock time for an UTC time.
TransformToUTCTime ( ClockTime clockTime ) : ClockTime	Returns the UTC time for a clock time.

Private Methods

Method	Description
TransformTimeZoneIdentifier ( String identifier ) : String	Transforms the time zone identifier.

Method Details

Clock() public method

Initializes a new instance of the Clock class.

/// The identifier is null. /// or /// The calendar basis is null. ///

public Clock ( String identifier, String name, ELTE.AEGIS.Temporal.Reference.Calendar basis, Duration offset ) : System
identifier	String	The identifier.
name	String	The name.
basis	ELTE.AEGIS.Temporal.Reference.Calendar	The basis.
offset	Duration	The offset.
return	System

Clock() public method

Initializes a new instance of the Clock class.

/// The identifier is null. /// or /// The calendar basis is null. ///

public Clock ( String identifier, String name, String remarks, Array aliases, String scope, ELTE.AEGIS.Temporal.Reference.Calendar basis, String referenceEvent, Instant referenceInstant, Duration offset ) : System
identifier	String	The identifier.
name	String	The name.
remarks	String	The remarks.
aliases	Array	The aliases.
scope	String	The scope.
basis	ELTE.AEGIS.Temporal.Reference.Calendar	The basis.
referenceEvent	String	The reference event.
referenceInstant	Instant	The reference instant.
offset	Duration	The offset.
return	System

FromTimeZone() public static method

Create a clock from a time zone.

The time zone is null.

public static FromTimeZone ( ELTE.AEGIS.Temporal.Reference.TimeZone timeZone, Boolean isDaylightSaving ) : Clock
timeZone	ELTE.AEGIS.Temporal.Reference.TimeZone	The time zone.
isDaylightSaving	Boolean	The value indicating whether the clock should be a daylight saving clock.
return	Clock

GetHour() public method

Returns the hours for an instant.

public GetHour ( Instant instant ) : Int32
instant	Instant	The instant.
return	Int32

GetHours() public method

Returns the hours for a duration.

public GetHours ( Duration duration ) : Int32
duration	Duration	The duration.
return	Int32

GetInstant() public method

Returns the instant for the specified time.

public GetInstant ( Int32 hours, Int32 minutes, Int32 seconds ) : Instant
hours	Int32	The hours.
minutes	Int32	The minutes.
seconds	Int32	The seconds.
return	Instant

GetInstant() public method

Returns the instant for the specified time.

public GetInstant ( Int32 hours, Int32 minutes, Int32 seconds, Int32 milliseconds ) : Instant
hours	Int32	The hours.
minutes	Int32	The minutes.
seconds	Int32	The seconds.
milliseconds	Int32	The milliseconds.
return	Instant

GetMilliseconds() public method

Returns the milliseconds within a second for a duration.

public GetMilliseconds ( Duration duration ) : Int32
duration	Duration	The duration.
return	Int32

GetMilliseconds() public method

Returns the milliseconds within a second for an instant.

public GetMilliseconds ( Instant instant ) : Int32
instant	Instant	The instant.
return	Int32

GetMinute() public method

Returns the minutes within an hour for an instant.

public GetMinute ( Instant instant ) : Int32
instant	Instant	The instant.
return	Int32

GetMinutes() public method

Returns the minutes within an hour for a duration.

public GetMinutes ( Duration duration ) : Int32
duration	Duration	The duration.
return	Int32

GetSecond() public method

Returns the seconds within a minute for an instant.

public GetSecond ( Instant instant ) : Int32
instant	Instant	The instant.
return	Int32

GetSeconds() public method

Returns the seconds within a minute for a duration.

public GetSeconds ( Duration duration ) : Int32
duration	Duration	The duration.
return	Int32

GetTime() public method

Returns the clock time for an instant.

public GetTime ( Instant instant ) : ClockTime
instant	Instant	The instant.
return	ClockTime

GetTotalMilliseconds() public method

Returns the total number of milliseconds for a duration.

public GetTotalMilliseconds ( Duration duration ) : Int32
duration	Duration	The duration.
return	Int32

GetTotalMilliseconds() public method

Returns the total number of milliseconds for an instant.

public GetTotalMilliseconds ( Instant instant ) : Int32
instant	Instant	The instant.
return	Int32

GetTotalMinutes() public method

Returns the total number of minutes for a duration.

public GetTotalMinutes ( Duration duration ) : Int32
duration	Duration	The duration.
return	Int32

GetTotalMinutes() public method

Returns the total number of minutes for an instant.

public GetTotalMinutes ( Instant instant ) : Int32
instant	Instant	The instant.
return	Int32

GetTotalSeconds() public method

Returns the total number of seconds for a duration.

public GetTotalSeconds ( Duration duration ) : Int32
duration	Duration	The duration.
return	Int32

GetTotalSeconds() public method

Returns the total number of seconds for an instant.

public GetTotalSeconds ( Instant instant ) : Int32
instant	Instant	The instant.
return	Int32

TransformToClockTime() public method

Returns the clock time for an UTC time.

The UTC time is null. The specified time is not an UTC time.

public TransformToClockTime ( ClockTime utcTime ) : ClockTime
utcTime	ClockTime	The UTC time.
return	ClockTime

TransformToUTCTime() public method

Returns the UTC time for a clock time.

The clock time is null. The specified time is not referenced in the current clock.

public TransformToUTCTime ( ClockTime clockTime ) : ClockTime
clockTime	ClockTime	The clock time.
return	ClockTime