GblDate Struct Reference

#include <gimbal_date_time.h>

Inheritance diagram for GblDate:

Data Fields
GblYear	year
GblMonth	month
GblDay	day

Related Symbols
(Note that these are not member symbols.)
Date Methods
Member functions for GblDate
GblBool	GblDate_isValid (const GblDate *pSelf)
GblBool	GblDate_isDst (const GblDate *pSelf)
GblDay	GblDate_toJulian (const GblDate *pSelf)
GblWeekDay	GblDate_weekDay (const GblDate *pSelf)
GblDay	GblDate_yearDay (const GblDate *pSelf)
uint8_t	GblDate_yearWeek (const GblDate *pSelf)
GblDate *	GblDate_fromJulian (GblDate *pSelf, GblDay julianDate)
GblDate *	GblDate_fromOrdinal (GblDate *pSelf, GblYear year, GblDay day)
void	GblDate_set (GblDate *pSelf, GblYear year, GblMonth month, GblDay day)
Time Static Methods
Non-member functions for time management
const char *	GblTime_amPmStr (GblBool isPm)
GblSecond	GblTime_localUtcOffset (void)
GblTimeSpec	GblTime_specDiff (const GblTimeSpec *pSrc1, const GblTimeSpec *pSrc2)

Detailed Description

Represents a calendar date.

Definition at line 115 of file gimbal_date_time.h.

Friends And Related Symbol Documentation

GblDate_isValid()

GblBool GblDate_isValid ( const GblDate *  pSelf )

related

Returns GBL_TRUE if the given structure represents a valid GblDate.

GblDate_isDst()

GblBool GblDate_isDst ( const GblDate *  pSelf )

related

Returns GBL_TRUE if the given date is during daylight savings time.

GblDate_toJulian()

GblDay GblDate_toJulian ( const GblDate *  pSelf )

related

Returns the Julian Day from the given date.

GblDate_weekDay()

GblWeekDay GblDate_weekDay ( const GblDate *  pSelf )

related

Returns the day of the week for the given date.

GblDate_yearDay()

GblDay GblDate_yearDay ( const GblDate *  pSelf )

related

Returns the day-of-the-year (1-365) for the given date.

GblDate_yearWeek()

uint8_t GblDate_yearWeek ( const GblDate *  pSelf )

related

Returns the week-of-the-year (1-52) for the given date.

GblDate_fromJulian()

GblDate * GblDate_fromJulian ( GblDate *  pSelf, GblDay  julianDate  )

related

Converts the given julian date to a GblDate, storing it in pSelf and returning it.

GblDate_fromOrdinal()

GblDate * GblDate_fromOrdinal ( GblDate *  pSelf, GblYear  year, GblDay  day  )

related

Converts the given ordinal date to a GblDate, storing it in pSelf and returning it.

GblDate_set()

void GblDate_set ( GblDate *  pSelf, GblYear  year, GblMonth  month, GblDay  day  )

related

Sets the given date structure, given its year, month, and day.

GblTime_amPmStr()

const char * GblTime_amPmStr ( GblBool  isPm )

related

Returns the string "PM" if isPm is GBL_TRUE, otherwise returns "AM".

GblTime_localUtcOffset()

GblSecond GblTime_localUtcOffset ( void  )

related

Returns the number of seconds the local time is offset from UTC time.

GblTime_specDiff()

GblTimeSpec GblTime_specDiff ( const GblTimeSpec *  pSrc1, const GblTimeSpec *  pSrc2  )

related

Returns the difference between two NS-resolution GblTimeSpec values.

Field Documentation

year

GblYear GblDate::year

Year.

Definition at line 116 of file gimbal_date_time.h.

month

GblMonth GblDate::month

Month of the year (1-12)

Definition at line 117 of file gimbal_date_time.h.

day

GblDay GblDate::day

Day of the month (1-31)

Definition at line 118 of file gimbal_date_time.h.

---

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

• gimbal_date_time.h