Collapse all Symbian^3 Application Developer Library

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 TBool	Enabled ()
IMPORT_C const TName &	Name ()
IMPORT_C TBool	Persists ()
IMPORT_C void	SetDueTime (const TTsTime &)
IMPORT_C void	SetEnabled ( TBool )
IMPORT_C void	SetName (const TName &)
IMPORT_C void	SetPersists ( TBool )
IMPORT_C TScheduleState2 &	operator= (const TScheduleState2 &)

Private Attributes
TTsTime	iDueTime
TUint32	iFlags
TName	iName
TAny *	iReserved

Constructor & Destructor Documentation

TScheduleState2()

IMPORT_C

TScheduleState2

(

)

Default Constructor for TScheduleState2 . By default, this state: has an empty string name, is non persistent, non enabled and its due time is set to zero.

TScheduleState2(const TScheduleState2 &)

IMPORT_C

TScheduleState2

(

const TScheduleState2 &

aScheduleState

)

Copy constructor for TScheduleState2

Parameters

const TScheduleState2 & aScheduleState

The TScheduleState2 object to be copied

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

IMPORT_C	TScheduleState2	(	const TName &	aName,
			const TTsTime &	aDueTime,
			TBool	aPersists,
			TBool	aEnabled
		)

Constructor taking the specified parameters.

Parameters

const TName & aName	The name of the schedule
const TTsTime & aDueTime	The time when the schedule is next due.
TBool aPersists	Boolean to indicate whether the schedule is persistent or not. 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
TBool aEnabled	Boolean to indicate whether the shedule is enabled or not.

Member Functions Documentation

DueTime()

IMPORT_C const TTsTime &

DueTime

(

)

const

Returns the time when the schedule is next due. TTsTime

Enabled()

IMPORT_C TBool

Enabled

(

)

const

Returns information on whether this schedule is enabled or not.

Name()

IMPORT_C const TName &

Name

(

)

const

Persists()

IMPORT_C TBool

Persists

(

)

const

Returns a boolean whether this schedule perists or not.

SetDueTime(const TTsTime &)

IMPORT_C void

SetDueTime

(

const TTsTime &

aDueTime

)

Sets the time when the schedule is next due. TTsTime

Parameters

const TTsTime & aDueTime

The time when the schedule is next due. This time could be either home time (for floating schedules) or UTC time.

SetEnabled(TBool)

IMPORT_C void

SetEnabled

(

TBool

aEnabled

)

Sets information on whether this schedule is enabled or not.

Parameters

TBool aEnabled

SetName(const TName &)

IMPORT_C void

SetName

(

const TName &

aName

)

Sets the name of the schedule

Parameters

const TName & aName

The name of the schedule

SetPersists(TBool)

IMPORT_C void

SetPersists

(

TBool

aPersists

)

Sets a boolean whether this schedule perists or not.

Parameters

TBool aPersists

Etrue if this schedule persits, EFalse if this schedule doen't persist.

operator=(const TScheduleState2 &)

IMPORT_C TScheduleState2 &

operator=

(

const TScheduleState2 &

aScheduleState

)

Assigns a TScheduleState2 to this object. Mem::Copy

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