DIY QlockTwo
Perfect DIY version of famous QlockTwo Classic with ESP8266
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
SimpleTime Class Reference

A simple representation of time with hour and minutes. More...

#include <SimpleTime.h>

Public Member Functions

 SimpleTime ()
 
 SimpleTime (SimpleTime const &_simpleTime)
 
 SimpleTime (uint16_t _hour, uint16_t _minute)
 
 SimpleTime (String timeString)
 
uint16_t getHour () const
 
void setHour (uint16_t hour)
 
uint16_t getMinute () const
 
void setMinute (uint16_t minute)
 
const int totalMinutes () const
 Calculate total minutes since 00:00. More...
 
 operator int () const
 Compare SimpleTimes over total minutes since 00:00. More...
 
String toString () const
 

Static Public Member Functions

static SimpleTime parse (String timeString)
 Parse String in format HH:MM. More...
 

Private Attributes

uint16_t hour
 
uint16_t minute
 

Detailed Description

A simple representation of time with hour and minutes.

Definition at line 13 of file SimpleTime.h.

Constructor & Destructor Documentation

◆ SimpleTime() [1/4]

SimpleTime::SimpleTime ( )
inline

Definition at line 18 of file SimpleTime.h.

◆ SimpleTime() [2/4]

SimpleTime::SimpleTime ( SimpleTime const &  _simpleTime)
inline

Definition at line 20 of file SimpleTime.h.

◆ SimpleTime() [3/4]

SimpleTime::SimpleTime ( uint16_t  _hour,
uint16_t  _minute 
)
inline

Definition at line 22 of file SimpleTime.h.

◆ SimpleTime() [4/4]

SimpleTime::SimpleTime ( String  timeString)
inline

Definition at line 24 of file SimpleTime.h.

Member Function Documentation

◆ getHour()

uint16_t SimpleTime::getHour ( ) const
inline

Definition at line 26 of file SimpleTime.h.

◆ getMinute()

uint16_t SimpleTime::getMinute ( ) const
inline

Definition at line 34 of file SimpleTime.h.

◆ operator int()

SimpleTime::operator int ( ) const
inline

Compare SimpleTimes over total minutes since 00:00.

Returns

Definition at line 54 of file SimpleTime.h.

◆ parse()

static SimpleTime SimpleTime::parse ( String  timeString)
inlinestatic

Parse String in format HH:MM.

Definition at line 62 of file SimpleTime.h.

◆ setHour()

void SimpleTime::setHour ( uint16_t  hour)
inline

Definition at line 30 of file SimpleTime.h.

◆ setMinute()

void SimpleTime::setMinute ( uint16_t  minute)
inline

Definition at line 38 of file SimpleTime.h.

◆ toString()

String SimpleTime::toString ( ) const
inline
Returns
SimpleTime as String in format HH:MM

Definition at line 76 of file SimpleTime.h.

◆ totalMinutes()

const int SimpleTime::totalMinutes ( ) const
inline

Calculate total minutes since 00:00.

Returns

Definition at line 46 of file SimpleTime.h.

Member Data Documentation

◆ hour

uint16_t SimpleTime::hour
private

Definition at line 15 of file SimpleTime.h.

◆ minute

uint16_t SimpleTime::minute
private

Definition at line 16 of file SimpleTime.h.

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