AskGeo.Astronomy.ZenithEvent Class Reference

A ZenithEvent object represents one of several particular and meaningful moments in the course of an astronomical body's passage across the celestial sphere of an observer. These include the rising and setting of the object in addition to a number of other important moments. More...

List of all members.

Public Member Functions
double	GetElevationDeg ()
DateTime	GetDateTime ()
long	GetTimeMsecs ()
ZenithEventType	GetEventType ()
override String	ToString ()

---

Detailed Description

A ZenithEvent object represents one of several particular and meaningful moments in the course of an astronomical body's passage across the celestial sphere of an observer. These include the rising and setting of the object in addition to a number of other important moments.

A full list of the zenith event types and their descriptions are given as the static public members of the ZenithEventType class.

The elevation (also known as altitude) of an astronomical body is the complement of the zenith and represents the angle above the horizon of the body.

It should be noted that in polar regions of the globe some of these events do not occur for months at a time. The only events that occur every day at every location on the globe are MinElevation and MaxElevation.

---

Member Function Documentation

DateTime AskGeo.Astronomy.ZenithEvent.GetDateTime

(

)

The time at which the event occurred as a .NET DateTime object.

Returns:

the time of the event as a .NET DateTime object.

double AskGeo.Astronomy.ZenithEvent.GetElevationDeg

(

)

The elevation is the angle of the astronomical body above the horizon. This is the angular complement of the zenith angle.

Returns:

the elevation of the body above the horizon in degrees.

ZenithEventType AskGeo.Astronomy.ZenithEvent.GetEventType

(

)

The event type (e.g., RiseUpperLimb or SetUpperLimb)

Returns:

the event type as represented by a value of the ZenithEvent.Type Java enumeration.

long AskGeo.Astronomy.ZenithEvent.GetTimeMsecs

(

)

The time at which the event occurred in milliseconds since 1970 (unix time).

Returns:

the time of the event in milliseconds since 1970.

override String AskGeo.Astronomy.ZenithEvent.ToString

(

)

A String representation of the ZenithEvent, used internally for testing and suitable for debugging purposes in client code.

Returns:

a String representation of the ZenithEvent.

---

The documentation for this class was generated from the following file:

• Source/Astronomy/ZenithEvent.cs