Public methods

absTime

IccAbsTime& absTime()

Returns a reference to an IccAbsTime object that contains the absolute time as provided by CICS®.

cancelAlarm

void cancelAlarm(const IccRequestId* reqId = 0)

reqId
An optional pointer to the IccRequestId object that holds information on an alarm request.

Cancels a previous setAlarm request if the alarm time has not yet been reached, that is, the request has not expired.

Conditions

ISCINVREQ, NOTAUTH, NOTFND, SYSIDERR

date

const char* date (DateFormat format = defaultFormat,
                  char dateSeparator = '\0')

format
An enumeration, defined in this class, that indicates in which format you want the date to be returned.
dateSeparator
The character that is used to separate different fields in the date. The default is no separation character.

Returns the date as a string.

Conditions

INVREQ

dayOfMonth

unsigned long dayOfMonth()

Returns the day component of the date, in the range 1 to 31.

Conditions

INVREQ

dayOfWeek

DayOfWeek dayOfWeek()

Returns an enumeration, defined in this class, that indicates the day of the week.

Conditions

INVREQ

daysSince1900

unsigned long daysSince1900()

Returns the number of days that have elapsed since 1st January, 1900.

Conditions

INVREQ

milliSeconds

long double milliSeconds()

Returns the number of milliseconds, rounded to the nearest hundredth of a second, that have elapsed since 00:00 on 1st January, 1900.

monthOfYear

MonthOfYear monthOfYear()

Returns an enumeration, defined in this class, that indicates the month of the year.

Conditions

INVREQ

setAlarm

const IccAlarmRequestId& setAlarm (const IccTime& time,
                                   const IccRequestId* reqId = 0)

time
A reference to an IccTime object that contains time information. As IccTime is an abstract class time is, in practise, an object of class IccAbsTime, IccTimeOfDay, or IccTimeInterval.
reqId
An optional pointer to an IccRequestId object that is used to identify this particular alarm request.

Sets an alarm at the time specified in time. It returns a reference to an IccAlarmRequestId object that can be used to cancel the alarm--see cancelAlarm method. See also the waitOnAlarm method on page waitOnAlarm of class IccTask.

Conditions

EXPIRED, INVREQ

time

const char* time(char timeSeparator = '\0')
timeSeparator
The character that delimits the time fields. The default is no separation character.

Returns the time as a text string.

Conditions

INVREQ

update

void update()

Updates the clock time and date from CICS. See the IccClock constructor.

year

unsigned long year()

Returns the 4-figure year number, such as 1996.

Conditions

INVREQ

[[ Contents Previous Page | Next Page Index ]]