AceTime  0.1
Date and time classes for Arduino that supports the TZ DAtabase, and a system clock synchronized from an NTP server or an RTC chip.
Public Member Functions | List of all members
ace_time::provider::TimeKeeper Class Referenceabstract

A TimeProvider whose time can be set by the end-user. More...

#include <TimeKeeper.h>

Inheritance diagram for ace_time::provider::TimeKeeper:
Inheritance graph
[legend]
Collaboration diagram for ace_time::provider::TimeKeeper:
Collaboration graph
[legend]

Public Member Functions

virtual void setNow (acetime_t epochSeconds)=0
 Set the time to the indicated seconds. More...
 
- Public Member Functions inherited from ace_time::provider::TimeProvider
virtual ~TimeProvider ()
 Virtual destructor. More...
 
virtual acetime_t getNow () const =0
 Return the number of seconds since the AceTime epoch (2000-01-01T00:00:00Z). More...
 
virtual void sendRequest () const
 Send a time request asynchronously. More...
 
virtual bool isResponseReady () const
 Return true if a response is ready. More...
 
virtual acetime_t readResponse () const
 Returns number of seconds since AceTime epoch (2000-01-01). More...
 

Additional Inherited Members

- Static Public Attributes inherited from ace_time::provider::TimeProvider
static const acetime_t kInvalidSeconds = INT32_MAX
 

Detailed Description

A TimeProvider whose time can be set by the end-user.

For example, an RTC chip.

Definition at line 14 of file TimeKeeper.h.

Member Function Documentation

virtual void ace_time::provider::TimeKeeper::setNow ( acetime_t  epochSeconds)
pure virtual

Set the time to the indicated seconds.

Calling with a value of kInvalidSeconds indicates an error condition, so the method should do nothing.

Implemented in ace_time::provider::SystemTimeKeeper.


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