Clock Entity

group ClockEntity

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.

void clock_getYear(unsigned int *id, struct Result *result, const int index)

Get the four digit year value (0-4095).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. Get the year portion of the real-time clock value.

  • index – The index of the entity in question.

void clock_setYear(unsigned int *id, struct Result *result, const int index, const unsigned short year)

Set the four digit year value (0-4095).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • year – Set the year portion of the real-time clock value.

void clock_getMonth(unsigned int *id, struct Result *result, const int index)

Get the two digit month value (1-12).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The two digit month portion of the real-time clock value.

  • index – The index of the entity in question.

void clock_setMonth(unsigned int *id, struct Result *result, const int index, const unsigned char month)

Set the two digit month value (1-12).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • month – The two digit month portion of the real-time clock value.

void clock_getDay(unsigned int *id, struct Result *result, const int index)

Get the two digit day of month value (1-28, 29, 30 or 31 depending on the month).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The two digit day portion of the real-time clock value.

  • index – The index of the entity in question.

void clock_setDay(unsigned int *id, struct Result *result, const int index, const unsigned char day)

Set the two digit day of month value (1-28, 29, 30 or 31 depending on the month).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • day – The two digit day portion of the real-time clock value.

void clock_getHour(unsigned int *id, struct Result *result, const int index)

Get the two digit hour value (0-23).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The two digit hour portion of the real-time clock value.

  • index – The index of the entity in question.

void clock_setHour(unsigned int *id, struct Result *result, const int index, const unsigned char hour)

Set the two digit hour value (0-23).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • hour – The two digit hour portion of the real-time clock value.

void clock_getMinute(unsigned int *id, struct Result *result, const int index)

Get the two digit minute value (0-59).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The two digit minute portion of the real-time clock value.

  • index – The index of the entity in question.

void clock_setMinute(unsigned int *id, struct Result *result, const int index, const unsigned char min)

Set the two digit minute value (0-59).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • min – The two digit minute portion of the real-time clock value.

void clock_getSecond(unsigned int *id, struct Result *result, const int index)

Get the two digit second value (0-59).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure. The two digit second portion of the real-time clock value.

  • index – The index of the entity in question.

void clock_setSecond(unsigned int *id, struct Result *result, const int index, const unsigned char sec)

Set the two digit second value (0-59).

Returns common entity return values

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • sec – The two digit second portion of the real-time clock value.