TMsvOffPeakTime Class Reference

#include <mw/msvoffpeaktime.h>

Link against: schsend.lib

class TMsvOffPeakTime

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()

Detailed Description

Defines an off-peak period for message sending.

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

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
aDay	Day start time.
aHour	Hour start time.
aMinute	Minute start time.
aValidityPeriod	Duration (in minutes).

Member Function Documentation

Day ( )

IMPORT_C TDay

Day

(

)

const

Gets the start time day parameter.

Return Value: Start time day parameter.

Hour ( )

IMPORT_C TInt

Hour

(

)

const

Gets the start time hour parameter.

Return Value: Start time hour parameter

Minute ( )

IMPORT_C TInt

Minute

(

)

const

Gets the start time minute parameter.

Return Value: 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
aFromTime	Specified time.

Return Value: Next 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
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.

Parameters
aHour	Start time hour parameter.

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

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.

Parameters
aMinute	Start time minute parameter.

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

SetValidityPeriod ( const TTimeIntervalMinutes )

IMPORT_C void

SetValidityPeriod

(

const TTimeIntervalMinutes

aValidityPeriod

)

Sets the duration parameter.

Parameters
aValidityPeriod	Duration parameter.

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

ValidityPeriod ( )

IMPORT_C const TTimeIntervalMinutes

ValidityPeriod

(

)

const

Gets the duration parameter.

Return Value: Duration parameter.