TScheduleState2 Class Reference

#include <schinfo.h>

Link against: schsvr.lib

class TScheduleState2
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 &)

Detailed Description

Defines the state of a schedule.

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

See also: RScheduler::GetScheduleL()

Constructor & Destructor Documentation

TScheduleState2 ( )

IMPORT_CTScheduleState2()

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_CTScheduleState2(const TScheduleState2 &aScheduleState)

Copy constructor for TScheduleState2

Parameters
aScheduleStateThe TScheduleState2 object to be copied

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

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

Constructor taking the specified parameters.

Parameters
aNameThe name of the schedule
aDueTimeThe time when the schedule is next due.
aPersistsBoolean 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
aEnabledBoolean to indicate whether the shedule is enabled or not.

Member Function Documentation

DueTime ( )

IMPORT_C const TTsTime &DueTime()const

Returns the time when the schedule is next due.

See also: TTsTime

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

Enabled ( )

IMPORT_C TBoolEnabled()const

Returns information on whether this schedule is enabled or not.

Return Value
Etrue if the schedule is enabled, EFalse id the schedule is not enabled.

Name ( )

IMPORT_C const TName &Name()const

Return Value
The name of the schedule

Persists ( )

IMPORT_C TBoolPersists()const

Returns a boolean whether this schedule perists or not.

Return Value
Etrue if this schedule persists, EFalse if this schedule doen't persist.

SetDueTime ( const TTsTime & )

IMPORT_C voidSetDueTime(const TTsTime &aDueTime)

Sets the time when the schedule is next due.

See also: TTsTime

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

SetEnabled ( TBool )

IMPORT_C voidSetEnabled(TBoolaEnabled)

Sets information on whether this schedule is enabled or not.

SetName ( const TName & )

IMPORT_C voidSetName(const TName &aName)

Sets the name of the schedule

Parameters
aNameThe name of the schedule

SetPersists ( TBool )

IMPORT_C voidSetPersists(TBoolaPersists)

Sets a boolean whether this schedule perists or not.

Parameters
aPersistsEtrue 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.

See also: Mem::Copy