TScheduleState2 Class Reference

class TScheduleState2

Defines the state of a schedule.

An object of this type is passed to, and populated by, a call to RScheduler::GetScheduleL().

RScheduler::GetScheduleL()

Public Member Functions
TScheduleState2()
TScheduleState2(const TScheduleState2 &)
TScheduleState2(const TName &, const TTsTime &, TBool, TBool)
IMPORT_C const TTsTime &DueTime()
IMPORT_C TBoolEnabled()
IMPORT_C const TName &Name()
IMPORT_C TBoolPersists()
IMPORT_C voidSetDueTime(const TTsTime &)
IMPORT_C voidSetEnabled(TBool)
IMPORT_C voidSetName(const TName &)
IMPORT_C voidSetPersists(TBool)
IMPORT_C TScheduleState2 &operator=(const TScheduleState2 &)
Private Attributes
TTsTime iDueTime
TUint32 iFlags
TName iName
TAny *iReserved

Constructor & Destructor Documentation

TScheduleState2()

IMPORT_CTScheduleState2()

TScheduleState2(const TScheduleState2 &)

IMPORT_CTScheduleState2(const TScheduleState2 &aScheduleState)

Parameters

const TScheduleState2 & aScheduleState

TScheduleState2(const TName &, const TTsTime &, TBool, TBool)

IMPORT_CTScheduleState2(const TName &aName,
const TTsTime &aDueTime,
TBoolaPersists,
TBoolaEnabled
)

Parameters

const TName & aName
const TTsTime & aDueTime
TBool aPersists
TBool aEnabled

Member Functions Documentation

DueTime()

IMPORT_C const TTsTime &DueTime()const

Enabled()

IMPORT_C TBoolEnabled()const

Name()

IMPORT_C const TName &Name()const

Persists()

IMPORT_C TBoolPersists()const

SetDueTime(const TTsTime &)

IMPORT_C voidSetDueTime(const TTsTime &aDueTime)

Parameters

const TTsTime & aDueTime

SetEnabled(TBool)

IMPORT_C voidSetEnabled(TBoolaEnabled)

Parameters

TBool aEnabled

SetName(const TName &)

IMPORT_C voidSetName(const TName &aName)

Parameters

const TName & aName

SetPersists(TBool)

IMPORT_C voidSetPersists(TBoolaPersists)

Parameters

TBool aPersists

operator=(const TScheduleState2 &)

IMPORT_C TScheduleState2 &operator=(const TScheduleState2 &aScheduleState)

Parameters

const TScheduleState2 & aScheduleState

Member Data Documentation

TTsTime iDueTime

TTsTime iDueTime[private]

The time when the schedule is next due. This only has meaning if the schedule is pending, i.e. it is enabled and has tasks associated with it.

TUint32 iFlags

TUint32 iFlags[private]

Flags used to indicate: 1. Whether the schedule is enabled or not. (bit 0) 2. Whether the schedule is persistent or not. (bit 1) If a schedule is persistent, its lifetime is not limited to the lifetime of the tasks associated with it . If a schedule is transient, it is created together with a new scheduled task, and is destroyed when the task is destroyed.

Bits 2-31 reserved for future use

TName iName

TName iName[private]

The name of the schedule.

TAny * iReserved

TAny *iReserved[private]

For future use