Clock Class¶
- class ClockClass : public EntityClass¶
ClockClass. Provides an interface to a real-time clock entity on a BrainStem module. The clock entity may be used to get and set the real time of the system. The clock entity has a one second resolution.
Note
Clock time must be reset if power to the BrainStem module is lost.
Public Functions
- ClockClass()¶
Constructors.
- ~ClockClass()¶
Destructor.
- !ClockClass ()
Finalizer.
- void init (BrainStem2CLI::ModuleClass^ module, const unsigned char index)
Initializes the class. Should only be called when manually creating classes.
- Parameters:
pModule – The module.
index – The cmdCLOCK index to be addressed.
- aErr getYear(unsigned short %year)¶
Get the four digit year value (0-4095).
- Parameters:
year – Get the year portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr setYear(const unsigned short year)¶
Set the four digit year value (0-4095).
- Parameters:
year – Set the year portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr getMonth(unsigned char %month)¶
Get the two digit month value (1-12).
- Parameters:
month – The two digit month portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr setMonth(const unsigned char month)¶
Set the two digit month value (1-12).
- Parameters:
month – The two digit month portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr getDay(unsigned char %day)¶
Get the two digit day of month value (1-28, 29, 30 or 31 depending on the month).
- Parameters:
day – The two digit day portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr setDay(const unsigned char day)¶
Get the two digit day of month value (1-28, 29, 30 or 31 depending on the month).
- Parameters:
day – The two digit day portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr getHour(unsigned char %hour)¶
Get the two digit hour value (0-23).
- Parameters:
hour – The two digit hour portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr setHour(const unsigned char hour)¶
Set the two digit hour value (0-23).
- Parameters:
hour – The two digit hour portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr getMinute(unsigned char %min)¶
Get the two digit minute value (0-59).
- Parameters:
min – The two digit minute portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr setMinute(const unsigned char min)¶
Set the two digit minute value (0-59).
- Parameters:
min – The two digit minute portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr getSecond(unsigned char %sec)¶
Get the two digit second value (0-59).
- Parameters:
sec – The two digit second portion of the real-time clock value.
- Returns:
Returns common entity return values
- aErr setSecond(const unsigned char sec)¶
Set the two digit second value (0-59).
- Parameters:
sec – The two digit second portion of the real-time clock value.
- Returns:
Returns common entity return values