Collapse all Symbian^3 Application Developer Library

TMsvOffPeakTime Class Reference

class TMsvOffPeakTime

Defines an off-peak period for message sending.

An off-peak period is specified as a start time and a duration.

Public Member Functions
	TMsvOffPeakTime ()
	TMsvOffPeakTime (const TDay , const TInt , const TInt , const TTimeIntervalMinutes )
IMPORT_C TDay	Day ()
IMPORT_C TInt	Hour ()
IMPORT_C TInt	Minute ()
IMPORT_C const TTime	NextTimeInclusive (const TTime &)
IMPORT_C void	Reset ()
IMPORT_C void	SetDay (const TDay )
IMPORT_C void	SetHour (const TInt )
IMPORT_C void	SetMinute (const TInt )
IMPORT_C void	SetValidityPeriod (const TTimeIntervalMinutes )
IMPORT_C const TTimeIntervalMinutes	ValidityPeriod ()

Private Attributes
TDay	iDay
TInt8	iHour
TInt8	iMinute
TTimeIntervalMinutes	iValidityPeriod

Constructor & Destructor Documentation

TMsvOffPeakTime()

IMPORT_C

TMsvOffPeakTime

(

)

Default constructor.

TMsvOffPeakTime(const TDay, const TInt, const TInt, const TTimeIntervalMinutes)

IMPORT_C	TMsvOffPeakTime	(	const TDay	aDay,
			const TInt	aHour,
			const TInt	aMinute,
			const TTimeIntervalMinutes	aValidityPeriod
		)

Constructor specifying off-peak time parameters. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

Parameters

const TDay aDay	Day start time.
const TInt aHour	Hour start time.
const TInt aMinute	Minute start time.
const TTimeIntervalMinutes aValidityPeriod	Duration (in minutes).

Member Functions Documentation

Day()

IMPORT_C TDay

Day

(

)

const

Gets the start time day parameter.

Hour()

IMPORT_C TInt

Hour

(

)

const

Gets the start time hour parameter.

Minute()

IMPORT_C TInt

Minute

(

)

const

Gets the start time minute parameter.

NextTimeInclusive(const TTime &)

IMPORT_C const TTime

NextTimeInclusive

(

const TTime &

aFromTime

)

const

Gets the next time, after a specified time, when this off-peak time becomes active.

If aFromTime is within the validity period of this off-peak time, then the next time will be less than or equal to aFromTime.

Parameters

const TTime & aFromTime

Specified time.

Reset()

IMPORT_C void

Reset

(

)

Resets the object to default settings.

SetDay(const TDay)

IMPORT_C void

SetDay

(

const TDay

aDay

)

Sets the start time day parameter. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

Parameters

const TDay aDay

Start time day parameter.

SetHour(const TInt)

IMPORT_C void

SetHour

(

const TInt

aHour

)

Sets the start time hour parameter. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

panic: ScheduleSend-DLL 12 The hour parameter is invalid (negative or more than 23).

Parameters

const TInt aHour

Start time hour parameter.

SetMinute(const TInt)

IMPORT_C void

SetMinute

(

const TInt

aMinute

)

Sets the start time minute parameter. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

panic: ScheduleSend-DLL 13 The minute parameter is invalid (negative or more than 59).

Parameters

const TInt aMinute

Start time minute parameter.

SetValidityPeriod(const TTimeIntervalMinutes)

IMPORT_C void

SetValidityPeriod

(

const TTimeIntervalMinutes

aValidityPeriod

)

Sets the duration parameter.

panic: ScheduleSend-DLL 10 The duration period is invalid (negative or more than 24 hours).

Parameters

const TTimeIntervalMinutes aValidityPeriod

Duration parameter.

ValidityPeriod()

IMPORT_C const TTimeIntervalMinutes

ValidityPeriod

(

)

const

Gets the duration parameter.

Member Data Documentation

TDay iDay

TDay

iDay

[private]

TInt8 iHour

TInt8

iHour

[private]

TInt8 iMinute

TInt8

iMinute

[private]

TTimeIntervalMinutes iValidityPeriod

TTimeIntervalMinutes

iValidityPeriod

[private]