cgnuino
Public Member Functions | List of all members
CgnPeriod Class Reference

Remembers current task period and its time constraint. More...

#include <cgnuino.h>

Public Member Functions

 CgnPeriod ()
 Constructor.
 
void set (String, uint32_t=0)
 Sets current task period and its time limitation. More...
 
bool is (String)
 Checks whether the current task period is s. More...
 
bool expire ()
 Checks whether the current task period expired its time limitation.
 
String get ()
 Shows current task period.
 
uint32_t until ()
 Shows the time limitation of the current task period.
 

Detailed Description

Remembers current task period and its time constraint.

Member Function Documentation

bool CgnPeriod::is ( String  s)

Checks whether the current task period is s.

Parameters
sName of the candidate task period.
void CgnPeriod::set ( String  s,
uint32_t  l = 0 
)

Sets current task period and its time limitation.

Parameters
sName of the current task period.
lMaximum length of current task period in [ms].

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