epoc32/include/mw/msvoffpeaktime.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __MSVOFFPEAKTIME_H__
williamr@2
    17
#define __MSVOFFPEAKTIME_H__
williamr@2
    18
williamr@2
    19
 
williamr@2
    20
williamr@2
    21
williamr@4
    22
//
williamr@2
    23
//
williamr@2
    24
//	Constants
williamr@2
    25
//
williamr@4
    26
//
williamr@2
    27
williamr@2
    28
williamr@4
    29
//
williamr@2
    30
//
williamr@2
    31
//	TMsvOffPeakTime Declaration
williamr@2
    32
//
williamr@4
    33
//
williamr@2
    34
williamr@2
    35
/**
williamr@2
    36
Defines an off-peak period for message sending.
williamr@2
    37
williamr@2
    38
An off-peak period is specified as a start time and a duration. 
williamr@2
    39
williamr@2
    40
@publishedAll
williamr@2
    41
@released
williamr@2
    42
*/
williamr@2
    43
williamr@2
    44
class TMsvOffPeakTime
williamr@2
    45
	{
williamr@2
    46
public:
williamr@2
    47
	IMPORT_C TMsvOffPeakTime();
williamr@2
    48
	IMPORT_C TMsvOffPeakTime(const TDay aDay, const TInt aHour, const TInt aMinute, const TTimeIntervalMinutes aValidityPeriod);
williamr@2
    49
williamr@2
    50
williamr@2
    51
	IMPORT_C void Reset();
williamr@2
    52
williamr@2
    53
	IMPORT_C TDay Day() const;
williamr@2
    54
	IMPORT_C void SetDay(const TDay aDay);
williamr@2
    55
williamr@2
    56
	IMPORT_C TInt Hour() const;
williamr@2
    57
	IMPORT_C void SetHour(const TInt aHour);
williamr@2
    58
williamr@2
    59
	IMPORT_C TInt Minute() const;
williamr@2
    60
	IMPORT_C void SetMinute(const TInt aMinute);
williamr@2
    61
williamr@2
    62
	IMPORT_C const TTimeIntervalMinutes ValidityPeriod() const;
williamr@2
    63
	IMPORT_C void SetValidityPeriod(const TTimeIntervalMinutes aValidityPeriod);
williamr@2
    64
williamr@2
    65
	IMPORT_C const TTime NextTimeInclusive(const TTime& aFromTime) const;
williamr@2
    66
williamr@2
    67
private:
williamr@2
    68
	TDay iDay;
williamr@2
    69
	TInt8 iHour;							//Start hour
williamr@2
    70
	TInt8 iMinute;							//Start minute
williamr@2
    71
	TTimeIntervalMinutes iValidityPeriod;	//Validity period. Must be less than 24 hours
williamr@2
    72
	};
williamr@2
    73
williamr@4
    74
//
williamr@2
    75
//
williamr@2
    76
//	CMsvOffPeakTimes Declaration
williamr@2
    77
//
williamr@4
    78
//
williamr@2
    79
williamr@2
    80
/**
williamr@2
    81
Array of off-peak time data.
williamr@2
    82
williamr@2
    83
This represents all the off-peak time periods in each week. 
williamr@2
    84
williamr@2
    85
@publishedAll
williamr@2
    86
@released
williamr@2
    87
*/
williamr@2
    88
williamr@2
    89
class CMsvOffPeakTimes : public CArrayFixFlat<TMsvOffPeakTime>
williamr@2
    90
	{
williamr@2
    91
public:
williamr@2
    92
	IMPORT_C CMsvOffPeakTimes();
williamr@2
    93
williamr@2
    94
williamr@2
    95
	IMPORT_C TInt GetNextOffPeakTime(const TTime& aFromTime, TMsvOffPeakTime& aNext, TTime& aNextTime) const;
williamr@2
    96
williamr@2
    97
protected:
williamr@2
    98
williamr@2
    99
williamr@2
   100
private:
williamr@2
   101
	};
williamr@2
   102
williamr@2
   103
#endif	// __MSVOFFPEAKTIME_H__