epoc32/include/msvoffpeaktime.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/msvoffpeaktime.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,103 @@
     1.4 +// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __MSVOFFPEAKTIME_H__
    1.20 +#define __MSVOFFPEAKTIME_H__
    1.21 +
    1.22 + 
    1.23 +
    1.24 +
    1.25 +/////////////////////////////////////////////////////////////////////////////
    1.26 +//
    1.27 +//	Constants
    1.28 +//
    1.29 +/////////////////////////////////////////////////////////////////////////////
    1.30 +
    1.31 +
    1.32 +/////////////////////////////////////////////////////////////////////////////
    1.33 +//
    1.34 +//	TMsvOffPeakTime Declaration
    1.35 +//
    1.36 +/////////////////////////////////////////////////////////////////////////////
    1.37 +
    1.38 +/**
    1.39 +Defines an off-peak period for message sending.
    1.40 +
    1.41 +An off-peak period is specified as a start time and a duration. 
    1.42 +
    1.43 +@publishedAll
    1.44 +@released
    1.45 +*/
    1.46 +
    1.47 +class TMsvOffPeakTime
    1.48 +	{
    1.49 +public:
    1.50 +	IMPORT_C TMsvOffPeakTime();
    1.51 +	IMPORT_C TMsvOffPeakTime(const TDay aDay, const TInt aHour, const TInt aMinute, const TTimeIntervalMinutes aValidityPeriod);
    1.52 +
    1.53 +
    1.54 +	IMPORT_C void Reset();
    1.55 +
    1.56 +	IMPORT_C TDay Day() const;
    1.57 +	IMPORT_C void SetDay(const TDay aDay);
    1.58 +
    1.59 +	IMPORT_C TInt Hour() const;
    1.60 +	IMPORT_C void SetHour(const TInt aHour);
    1.61 +
    1.62 +	IMPORT_C TInt Minute() const;
    1.63 +	IMPORT_C void SetMinute(const TInt aMinute);
    1.64 +
    1.65 +	IMPORT_C const TTimeIntervalMinutes ValidityPeriod() const;
    1.66 +	IMPORT_C void SetValidityPeriod(const TTimeIntervalMinutes aValidityPeriod);
    1.67 +
    1.68 +	IMPORT_C const TTime NextTimeInclusive(const TTime& aFromTime) const;
    1.69 +
    1.70 +private:
    1.71 +	TDay iDay;
    1.72 +	TInt8 iHour;							//Start hour
    1.73 +	TInt8 iMinute;							//Start minute
    1.74 +	TTimeIntervalMinutes iValidityPeriod;	//Validity period. Must be less than 24 hours
    1.75 +	};
    1.76 +
    1.77 +/////////////////////////////////////////////////////////////////////////////
    1.78 +//
    1.79 +//	CMsvOffPeakTimes Declaration
    1.80 +//
    1.81 +/////////////////////////////////////////////////////////////////////////////
    1.82 +
    1.83 +/**
    1.84 +Array of off-peak time data.
    1.85 +
    1.86 +This represents all the off-peak time periods in each week. 
    1.87 +
    1.88 +@publishedAll
    1.89 +@released
    1.90 +*/
    1.91 +
    1.92 +class CMsvOffPeakTimes : public CArrayFixFlat<TMsvOffPeakTime>
    1.93 +	{
    1.94 +public:
    1.95 +	IMPORT_C CMsvOffPeakTimes();
    1.96 +
    1.97 +
    1.98 +	IMPORT_C TInt GetNextOffPeakTime(const TTime& aFromTime, TMsvOffPeakTime& aNext, TTime& aNextTime) const;
    1.99 +
   1.100 +protected:
   1.101 +
   1.102 +
   1.103 +private:
   1.104 +	};
   1.105 +
   1.106 +#endif	// __MSVOFFPEAKTIME_H__