E57 Simple API V1.0.312  Aug. 10, 2012
Public Member Functions | Public Attributes | List of all members
e57::DateTime Class Reference

The e57::DateTime is a structure for encoding date and time. More...

#include <E57Simple.h>

Public Member Functions

 DateTime (void)
 This function is the constructor for the DateTime class.
 
 ~DateTime (void)
 This function is the destructor for the DateTime class.
 
void SetCurrentGPSTime (void)
 This function sets dateTimeValue to be the current GPS time.
 
void SetUTCDateTime (int year, int month, int day, int hour, int minute, float seconds)
 This function sets dateTimeValue to be the given date and time.
 
void GetUTCDateTime (int &year, int &month, int &day, int &hour, int &minute, float &seconds)
 This function gets the date and time from the gps dateTimeValue;.
 

Public Attributes

double dateTimeValue
 The time, in seconds, since GPS time was zero. This time specification may include fractions of a second.
 
int32_t isAtomicClockReferenced
 This element should be present, and its value set to 1 if, and only if, the time stored in the dateTimeValue element is obtained from an atomic clock time source. Shall be either 0 or 1.
 

Detailed Description

The e57::DateTime is a structure for encoding date and time.

The date and time is encoded using a single 562 floating point number, stored as an E57 Float element which is based on the Global Positioning 563 System (GPS) time scale.

Member Function Documentation

void DateTime::GetUTCDateTime ( int &  year,
int &  month,
int &  day,
int &  hour,
int &  minute,
float &  seconds 
)

This function gets the date and time from the gps dateTimeValue;.

Parameters
yearThe year 1900-9999
monthThe month 0-11
dayThe day 1-31
hourThe hour 0-23
minuteThe minute 0-59
secondsThe seconds 0.0 - 59.999
void DateTime::SetUTCDateTime ( int  year,
int  month,
int  day,
int  hour,
int  minute,
float  seconds 
)

This function sets dateTimeValue to be the given date and time.

Parameters
yearThe year 1900-9999
monthThe month 0-11
dayThe day 1-31
hourThe hour 0-23
minuteThe minute 0-59
secondsThe seconds 0.0 - 59.999

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