TimeOfDay Struct Reference

A simple value type representing a time of day (hour, minute, second). More...

#include <TimeOfDay.h>

Collaboration diagram for TimeOfDay:

Public Member Functions
bool	operator== (const TimeOfDay &other) const
bool	operator!= (const TimeOfDay &other) const
bool	operator< (const TimeOfDay &other) const
bool	operator<= (const TimeOfDay &other) const
bool	operator> (const TimeOfDay &other) const
bool	operator>= (const TimeOfDay &other) const

Static Public Member Functions
static TimeOfDay	fromString (const char *hhmm)
	Parse a string in the form "HH:MM" or "HH:MM:SS".
static std::string	toString (const TimeOfDay &time)
	Format the time as a string.

Public Attributes
uint8_t	hour = 0
uint8_t	minute = 0
uint8_t	second = 0

Detailed Description

Definition at line 21 of file TimeOfDay.h.

Member Function Documentation

fromString()

static TimeOfDay TimeOfDay::fromString ( const char *  hhmm )

inlinestatic

Parameters

hhmm	Input time string.

Returns

Parsed TimeOfDay (defaults to 00:00:00 on error).

Definition at line 32 of file TimeOfDay.h.

                                                  {
        TimeOfDay t;
        if (sscanf(hhmm, "%2hhu:%2hhu:%2hhu", &t.hour, &t.minute, &t.second) == 3) {
            return t;
        } else if (sscanf(hhmm, "%2hhu:%2hhu", &t.hour, &t.minute) == 2) {
            t.second = 0;
            return t;
        }
        return {0, 0, 0};
    }

References hour, minute, and second.

Referenced by from_json().

Here is the caller graph for this function:

operator!=()

bool TimeOfDay::operator!= ( const TimeOfDay &  other ) const

inline

Definition at line 64 of file TimeOfDay.h.

                                                  {
        return !(*this == other);
    }

operator<()

bool TimeOfDay::operator< ( const TimeOfDay &  other ) const

inline

Definition at line 68 of file TimeOfDay.h.

                                                 {
        if (hour != other.hour) return hour < other.hour;
        if (minute != other.minute) return minute < other.minute;
        return second < other.second;
    }

References hour, minute, and second.

operator<=()

bool TimeOfDay::operator<= ( const TimeOfDay &  other ) const

inline

Definition at line 74 of file TimeOfDay.h.

                                                  {
        return !(*this > other);
    }

operator==()

bool TimeOfDay::operator== ( const TimeOfDay &  other ) const

inline

Definition at line 60 of file TimeOfDay.h.

                                                  {
        return hour == other.hour && minute == other.minute && second == other.second;
    }

References hour, minute, and second.

operator>()

bool TimeOfDay::operator> ( const TimeOfDay &  other ) const

inline

Definition at line 78 of file TimeOfDay.h.

                                                 {
        return other < *this;
    }

operator>=()

bool TimeOfDay::operator>= ( const TimeOfDay &  other ) const

inline

Definition at line 82 of file TimeOfDay.h.

                                                  {
        return !(*this < other);
    }

toString()

static std::string TimeOfDay::toString ( const TimeOfDay &  time )

inlinestatic

Parameters

time	Input time.

Returns

Formatted string, either "HH:MM" or "HH:MM:SS" depending on seconds.

Definition at line 48 of file TimeOfDay.h.

                                                     {
        char buf[9];
        if (time.second > 0) {
            snprintf(buf, sizeof(buf), "%02u:%02u:%02u", time.hour, time.minute, time.second);
        } else {
            snprintf(buf, sizeof(buf), "%02u:%02u", time.hour, time.minute);
        }
        return std::string(buf);
    }

References hour, minute, and second.

Referenced by to_json().

Here is the caller graph for this function:

Member Data Documentation

hour

uint8_t TimeOfDay::hour = 0

Definition at line 23 of file TimeOfDay.h.

Referenced by fromString(), operator<(), operator==(), toSeconds(), and toString().

minute

uint8_t TimeOfDay::minute = 0

Definition at line 24 of file TimeOfDay.h.

Referenced by fromString(), operator<(), operator==(), toSeconds(), and toString().

second

uint8_t TimeOfDay::second = 0

Definition at line 25 of file TimeOfDay.h.

Referenced by fromString(), operator<(), operator==(), toSeconds(), and toString().

---

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

• TimeOfDay.h