EmlaLockSafe
configuration::Configuration::TimeRestrictions Class Reference

Container to restrict the time when the safe can be opened. More...

#include <Configuration.h>

Public Member Functions

 TimeRestrictions ()
 Construct a new Time Restrictions object. More...
 
bool checkTime () const
 check if the current time is valid for opening the safe More...
 

Public Attributes

uint32_t startTime
 The number of seconds after midnight after which the safe can be opened. More...
 
uint32_t endTime
 The number of seconds after midnight until which the safe can be opened. More...
 
bool restrictUnlockTimes
 If set, the safe can only be opened during the specified time using the normal unlock function. More...
 
bool restrictHygieneOpeningTimes
 If set, the time for hygiene openings is restricted. More...
 
bool restrictEmergencyKeyTimes
 If set, the time when the emergency key is accepted is restricted. More...
 
bool restrictConfigurationServer
 If set, the time when the configuration server can be started is restricted. More...
 

Protected Member Functions

void readFromFile (File &file)
 Reads the content of this class from the configuration file stream. More...
 
void writeToFile (File &file)
 Writes all configuration items of this class to the file at the current stream position. More...
 

Friends

class Configuration
 

Detailed Description

Container to restrict the time when the safe can be opened.

The safe can only be opened between start and endTime

Constructor & Destructor Documentation

◆ TimeRestrictions()

configuration::Configuration::TimeRestrictions::TimeRestrictions ( )
inline

Construct a new Time Restrictions object.

Member Function Documentation

◆ checkTime()

bool configuration::Configuration::TimeRestrictions::checkTime ( ) const
inline

check if the current time is valid for opening the safe

◆ readFromFile()

void configuration::Configuration::TimeRestrictions::readFromFile ( File &  file)
inlineprotected

Reads the content of this class from the configuration file stream.

Parameters
filefile stream at the position where the data should be located

◆ writeToFile()

void configuration::Configuration::TimeRestrictions::writeToFile ( File &  file)
inlineprotected

Writes all configuration items of this class to the file at the current stream position.

Parameters
filefile stream at the position where the data should be located

Friends And Related Function Documentation

◆ Configuration

friend class Configuration
friend

Member Data Documentation

◆ endTime

uint32_t configuration::Configuration::TimeRestrictions::endTime

The number of seconds after midnight until which the safe can be opened.

◆ restrictConfigurationServer

bool configuration::Configuration::TimeRestrictions::restrictConfigurationServer

If set, the time when the configuration server can be started is restricted.

◆ restrictEmergencyKeyTimes

bool configuration::Configuration::TimeRestrictions::restrictEmergencyKeyTimes

If set, the time when the emergency key is accepted is restricted.

◆ restrictHygieneOpeningTimes

bool configuration::Configuration::TimeRestrictions::restrictHygieneOpeningTimes

If set, the time for hygiene openings is restricted.

◆ restrictUnlockTimes

bool configuration::Configuration::TimeRestrictions::restrictUnlockTimes

If set, the safe can only be opened during the specified time using the normal unlock function.

◆ startTime

uint32_t configuration::Configuration::TimeRestrictions::startTime

The number of seconds after midnight after which the safe can be opened.


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