sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #include "SCHINFO.H"
sl@0: #include "SCHEXEC.H"
sl@0: 
sl@0: /**
sl@0: Persists flag value, used by TScheduleState2
sl@0: @internalComponent
sl@0: */
sl@0: const TUint32 KPersists = 0x00000001;
sl@0: 
sl@0: 
sl@0: /**
sl@0: IsEnabled flag value, used by TScheduleState2
sl@0: @internalComponent
sl@0: */
sl@0: const TUint32 KIsEnabled = 0x00000002;
sl@0: 
sl@0: 
sl@0: EXPORT_C TTaskInfo::TTaskInfo(TInt aTaskId, TName& aName, TInt aPriority, TInt aRepeat)
sl@0: 				:iRepeat(aRepeat), iTaskId(aTaskId), iName(aName), iPriority(aPriority)
sl@0: /** Constructor taking the specified parameters.
sl@0: 
sl@0: @param aTaskId The task Id.
sl@0: @param aName The name of the task.
sl@0: @param aPriority The task priority.
sl@0: @param aRepeat How often the task is to be repeated */
sl@0: 	{
sl@0: 	} 
sl@0: 
sl@0: EXPORT_C TTaskInfo::TTaskInfo()
sl@0: /** Default constructor. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TTaskInfo& TTaskInfo::operator=(const TTaskInfo& aTaskInfo)
sl@0: 	{
sl@0: 	Mem::Copy(this,&aTaskInfo,sizeof(*this));
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void TTaskInfo::ExternalizeL(RWriteStream& aWriteStream) const
sl@0: /** Externalises an object of this class to a write stream.
sl@0: 	
sl@0: 	The presence of this function means that the standard templated operator<<() 
sl@0: 	can be used to externalise objects of this class.
sl@0: 	
sl@0: 	@param aStream Stream to which the object should be externalised. */
sl@0: 	{
sl@0: 	aWriteStream << iName;
sl@0: 	aWriteStream.WriteInt32L(iTaskId);
sl@0: 	aWriteStream.WriteInt32L(iRepeat);
sl@0: 	aWriteStream.WriteInt32L(iPriority);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void TTaskInfo::InternalizeL(RReadStream& aReadStream)
sl@0: 	/** Internalises an object of this class from a read stream.
sl@0: 	
sl@0: 	The presence of this function means that the standard templated operator>>() 
sl@0: 	can be used to internalise objects of this class.
sl@0: 	
sl@0: 	Note that the function has assignment semantics. It replaces the old value 
sl@0: 	of the object with a new value read from the read stream.
sl@0: 	
sl@0: 	@param aStream Stream from which the object is to be internalised. */
sl@0: 	{
sl@0: 	aReadStream >> iName;
sl@0: 	iTaskId = aReadStream.ReadInt32L();
sl@0: 	iRepeat = aReadStream.ReadInt32L();
sl@0: 	iPriority = aReadStream.ReadInt32L();
sl@0: 	}
sl@0: 
sl@0: //
sl@0: /**
sl@0: Externalizes the ScheduleEntryInfo
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void TScheduleEntryInfo::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream.WriteInt32L(iValidityPeriod.Int());
sl@0: 	aStream.WriteInt32L(iInterval);
sl@0: 	aStream.WriteInt8L(iIntervalType);
sl@0: 	TInt64 asInt = iStartTime.Int64();
sl@0: 	aStream.WriteInt32L(I64LOW(asInt));
sl@0: 	aStream.WriteInt32L(I64HIGH(asInt));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Internalizes the ScheduleEntryInfo
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void TScheduleEntryInfo::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	iValidityPeriod = aStream.ReadInt32L();
sl@0: 	iInterval = aStream.ReadInt32L();
sl@0: 	iIntervalType = TIntervalType(aStream.ReadInt8L());
sl@0: 	TInt64 asInt;
sl@0: 	TInt lo;
sl@0: 	TInt hi;
sl@0: 	lo=aStream.ReadInt32L();
sl@0: 	hi=aStream.ReadInt32L();
sl@0: 	asInt = MAKE_TINT64(hi,lo);
sl@0: 	iStartTime = asInt;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: TScheduleEntryInfo2 Default constructor. 
sl@0: It sets the object's members data to the following default values.
sl@0: iIntervalType : EHourly
sl@0: iStartTime : UTC time set to 0
sl@0: iInterval : 0
sl@0: iValidityPeriod : 0
sl@0: */
sl@0: EXPORT_C TScheduleEntryInfo2::TScheduleEntryInfo2() :
sl@0: 		iInterval(0),
sl@0: 		iIntervalType(TIntervalType(0)),
sl@0: 		iValidityPeriod(0),
sl@0: 		iReserved(NULL)
sl@0: 	{
sl@0: 		
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Copy constructor for TScheduleEntryInfo2
sl@0: Sets the parameter's data to this object.
sl@0: @param aEntryInfo The TScheduleEntryInfo2 object to be copied
sl@0: */	
sl@0: EXPORT_C TScheduleEntryInfo2::TScheduleEntryInfo2(const TScheduleEntryInfo2& aEntryInfo)
sl@0: 	{
sl@0: 	*this = aEntryInfo;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: TScheduleEntryInfo2 constructor taking the specified parameters.
sl@0: 
sl@0: @param aStartTime The first time that the entry will cause execution of tasks
sl@0: @param aIntervalType Defines the type of time-frame relative to which execution of tasks is timed; 
sl@0: for example, EHourly implies relative to the current hour, EDaily implies 
sl@0: relative to the current day
sl@0: @param aInterval The interval between execution of tasks
sl@0: For a schedule entry interval to be valid, it should be greater than or equal to 1
sl@0: @param aIntervalMinutes The period for which the entry is valid
sl@0: */	
sl@0: EXPORT_C TScheduleEntryInfo2::TScheduleEntryInfo2(const TTsTime& aStartTime, TIntervalType aIntervalType, TInt aInterval, TTimeIntervalMinutes aValidityPeriod)
sl@0: 	{
sl@0: 	iStartTime = aStartTime;
sl@0: 	iIntervalType = aIntervalType;
sl@0: 	iInterval = aInterval;
sl@0: 	iValidityPeriod = aValidityPeriod ;
sl@0: 	iReserved = NULL;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the Interval Type
sl@0: @return The type of interval used between due times for this schedule entry.
sl@0: The type of interval used may be EHourly, EDaily, EMonthly or EYearly.
sl@0: @see TIntervalType
sl@0: */
sl@0: EXPORT_C TIntervalType TScheduleEntryInfo2::IntervalType() const
sl@0: 	{
sl@0: 	return iIntervalType;	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sets the type of interval used between due times for this schedule entry.
sl@0: The type of interval used may be EHourly, EDaily, EMonthly or EYearly.
sl@0: @param aIntervalType The type of interval to be used.
sl@0: @see TIntervalType
sl@0: */	
sl@0: EXPORT_C void TScheduleEntryInfo2::SetIntervalType(TIntervalType aIntervalType)
sl@0: 	{
sl@0: 	iIntervalType = aIntervalType;	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the first time at which the entry will cause execution of tasks.
sl@0: @return Start time - this TTsTime value may be either UTC or local time based.
sl@0: Entries with local time based start times will remain at that local time regardless of
sl@0: timezone or DST changes (ie. will float). Entries with UTC based start times, will
sl@0: remain at the given UTC time (will not float).
sl@0: @see TTsTime
sl@0: */
sl@0: EXPORT_C const TTsTime& TScheduleEntryInfo2::StartTime() const
sl@0: 	{
sl@0: 	return iStartTime;	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sets the first time the entry will cause execution of tasks.
sl@0: @param aStartTime This TTsTime value may be either UTC or local time based.
sl@0: If this is a local time based value, the schedule entry will remain
sl@0: at that local time regardless of timezone and DST changes (ie. it will float)
sl@0: If the value is UTC based, the schedule entry will remain at that UTC time (will not float).
sl@0: @see TTsTime
sl@0: */
sl@0: EXPORT_C void TScheduleEntryInfo2::SetStartTime(const TTsTime& aStartTime)
sl@0: 	{
sl@0: 	iStartTime = aStartTime;
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Returns the interval between execution of tasks.
sl@0: @return Interval between execution of tasks. 
sl@0: For a schedule entry interval to be valid, it should be greater than or equal to 1.
sl@0: @see TScheduleEntryInfo2::SetInterval
sl@0: */	
sl@0: EXPORT_C TInt TScheduleEntryInfo2::Interval() const
sl@0: 	{
sl@0: 	return 	iInterval;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sets the interval between execution of tasks.
sl@0: The way that this value is interpreted depends on the value of iIntervalType. 
sl@0: For example, if the interval is 2 and iIntervalType has a value of EMonthly, 
sl@0: then the interval is 2 months. 
sl@0: @param aInterval For a schedule entry interval to be valid, it should be greater than or equal to 1.
sl@0: */	
sl@0: EXPORT_C void TScheduleEntryInfo2::SetInterval(TInt aInterval)
sl@0: 	{
sl@0: 	iInterval = aInterval;	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Return the period for which the entry is valid.
sl@0: After the validity period has expired, tasks associated with the entry will 
sl@0: not be eligible for execution
sl@0: @return TTimeIntervalMinutes
sl@0: */
sl@0: EXPORT_C TTimeIntervalMinutes TScheduleEntryInfo2::ValidityPeriod() const
sl@0: 	{
sl@0: 	return iValidityPeriod;	
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Sets the period for which the entry is valid.
sl@0: After the validity period has expired, tasks associated with the entry will 
sl@0: not be eligible for execution
sl@0: @param aValidityPeriod, the period for which the entry is valid
sl@0: @see TTimeIntervalMinutes
sl@0: */	
sl@0: EXPORT_C void TScheduleEntryInfo2::SetValidityPeriod(TTimeIntervalMinutes aValidityPeriod)
sl@0: 	{
sl@0: 	iValidityPeriod = aValidityPeriod;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Non exported constructor accepting a TScheduleEntryInfo parameter
sl@0: This constructor is provided for use with the deprecated APIs.
sl@0: This will assume home time in order to maintain backwards compatibility and will create a #
sl@0: TScheduleEntryInfo2 object with a local time based start time.
sl@0: @param aEntryInfo Entry info of deprecated type TScheduleEntryInfo
sl@0: @see TScheduleEntryInfo
sl@0: */
sl@0: TScheduleEntryInfo2::TScheduleEntryInfo2(const TScheduleEntryInfo& aEntryInfo)
sl@0: 	{	
sl@0: 	iStartTime.SetLocalTime(aEntryInfo.iStartTime);
sl@0: 	iIntervalType = aEntryInfo.iIntervalType;
sl@0: 	iInterval = aEntryInfo.iInterval;
sl@0: 	iValidityPeriod = aEntryInfo.iValidityPeriod ;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Externalises an object of this class to a write stream.
sl@0: The presence of this function means that the standard templated operator<<() 
sl@0: can be used to externalise objects of this class.
sl@0: 	
sl@0: @param aStream Stream to which the object should be externalised.
sl@0: @internalComponent only used by server
sl@0: */
sl@0: void TScheduleEntryInfo2::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream << iStartTime;
sl@0: 	aStream.WriteInt32L(iIntervalType);	
sl@0: 	aStream.WriteInt32L(iInterval);
sl@0: 	aStream.WriteInt32L(iValidityPeriod.Int());	
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: /**
sl@0: Internalises an object of this class from a read stream.
sl@0: The presence of this function means that the standard templated operator>>() 
sl@0: can be used to internalise objects of this class.
sl@0: 		
sl@0: @param aStream Stream from which the object is to be internalised.
sl@0: @internalComponent only used by server
sl@0: */	
sl@0: void TScheduleEntryInfo2::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	aStream >> iStartTime;
sl@0: 	iIntervalType = TIntervalType(aStream.ReadInt32L());
sl@0: 	iInterval = aStream.ReadInt32L();
sl@0: 	iValidityPeriod = aStream.ReadInt32L();
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Calls ProcessOffsetEvent() on TScheduleEntryInfo's start time member
sl@0: @see TTsTime::ProcessOffsetEvent
sl@0: @internalComponent only used by the server
sl@0: */
sl@0: void TScheduleEntryInfo2::ProcessOffsetEvent()
sl@0: 	{
sl@0: 	iStartTime.ProcessOffsetEvent();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Assignment operator for TScheduleEntryInfo2
sl@0: @see Mem::Copy
sl@0: */
sl@0: EXPORT_C TScheduleEntryInfo2& TScheduleEntryInfo2::operator=(const TScheduleEntryInfo2& aEntryInfo)
sl@0: 	{
sl@0: 	Mem::Copy(this,&aEntryInfo,sizeof(*this));
sl@0: 	return *this;
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Default Constructor for TScheduleState2.
sl@0: By default, this state: has an empty string name, is non persistent, non enabled and its due time is set to zero.
sl@0: */
sl@0: EXPORT_C TScheduleState2::TScheduleState2():
sl@0: 	iName(_L("")),
sl@0: 	iFlags(0),
sl@0: 	iReserved(NULL)
sl@0: 	{
sl@0: 		
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Copy constructor for TScheduleState2
sl@0: @param aScheduleState The TScheduleState2 object to be copied
sl@0: */	
sl@0: EXPORT_C TScheduleState2::TScheduleState2(const TScheduleState2& aScheduleState)
sl@0: 	{
sl@0: 	*this = aScheduleState;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructor taking the specified parameters.
sl@0: @param	aName The name of the schedule
sl@0: @param 	aDueTime The time when the schedule is next due.
sl@0: @param 	aPersists Boolean to indicate whether the schedule is persistent or not.
sl@0: if a schedule is persistent, its lifetime is not limited to the lifetime of 
sl@0: the tasks associated with it.
sl@0: If a schedule is transient, it is created together with a new scheduled task, 
sl@0: and is destroyed when the task is destroyed
sl@0: @param 	aEnabled Boolean to indicate whether the shedule is enabled or not.
sl@0: */	
sl@0: EXPORT_C TScheduleState2::TScheduleState2(const TName& aName, const TTsTime& aDueTime, TBool aPersists, TBool aEnabled)
sl@0: 	{
sl@0: 	iName = aName;
sl@0: 	iDueTime = aDueTime;
sl@0: 	SetPersists(aPersists);
sl@0: 	SetEnabled(aEnabled);
sl@0: 	iReserved = NULL;
sl@0: 	
sl@0: 	}
sl@0: 		
sl@0: /**
sl@0: @return  The name of the schedule
sl@0: */
sl@0: EXPORT_C const TName& TScheduleState2::Name() const
sl@0: 	{
sl@0: 	return iName;	
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Sets the name of the schedule
sl@0: @param aName The name of the schedule
sl@0: */	
sl@0: EXPORT_C void TScheduleState2::SetName(const TName& aName)
sl@0: 	{
sl@0: 	iName = aName;	
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Returns the time when the schedule is next due.
sl@0: @return The time when the schedule is next due. This time could be either home time (for floating schedules) or UTC time.
sl@0: @see TTsTime
sl@0: */
sl@0: EXPORT_C const TTsTime& TScheduleState2::DueTime() const
sl@0: 	{
sl@0: 	return iDueTime;	
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: /**
sl@0: Sets the time when the schedule is next due.
sl@0: @param aDueTime The time when the schedule is next due. This time could be either home time (for floating schedules) or UTC time.
sl@0: @see TTsTime
sl@0: */	
sl@0: EXPORT_C void TScheduleState2::SetDueTime(const TTsTime& aDueTime)
sl@0: 	{
sl@0: 	iDueTime = aDueTime;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Returns a boolean whether this schedule perists or not.
sl@0: @return Etrue if this schedule persists, EFalse if this schedule doen't persist.
sl@0: */
sl@0: EXPORT_C TBool TScheduleState2::Persists() const
sl@0: 	{
sl@0: 	return iFlags & KPersists ? ETrue: EFalse;		
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: 
sl@0: /**
sl@0: Sets a boolean whether this schedule perists or not.
sl@0: @param aPersists Etrue if this schedule persits, EFalse if this schedule doen't persist.
sl@0: */	
sl@0: EXPORT_C void TScheduleState2::SetPersists(TBool aPersists)
sl@0: 	{
sl@0: 	if(aPersists )
sl@0: 		iFlags |= KPersists;
sl@0: 	else
sl@0: 		iFlags &= ~KPersists;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Returns information on whether this schedule is enabled or not.
sl@0: @return Etrue if the schedule is enabled, EFalse id the schedule is not enabled.
sl@0: */
sl@0: EXPORT_C TBool TScheduleState2::Enabled() const
sl@0: 	{
sl@0: 	return iFlags & KIsEnabled ? ETrue: EFalse;	
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: /**
sl@0: Sets information on whether this schedule is enabled or not.
sl@0: @param aEnabled 
sl@0: */	
sl@0: EXPORT_C void TScheduleState2::SetEnabled(TBool aEnabled)
sl@0: 	{
sl@0: 	if(aEnabled )
sl@0: 		iFlags |= KIsEnabled;
sl@0: 	else
sl@0: 		iFlags &= ~KIsEnabled;	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Assigns a TScheduleState2 to this object.
sl@0: @see Mem::Copy
sl@0: */
sl@0: EXPORT_C TScheduleState2& TScheduleState2::operator=(const TScheduleState2& aScheduleState)
sl@0: 	{
sl@0: 	Mem::Copy(this,&aScheduleState,sizeof(*this));
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: A constructor for TScheduleState that takes a TScheduleState2 parameter,
sl@0: for use with the deprecated APIs. All TScheduleStates created will have 
sl@0: local time based iDueTime data members.
sl@0: @internalComponent
sl@0: */
sl@0: TScheduleState::TScheduleState(const TScheduleState2& aScheduleState2)
sl@0: 	{
sl@0: 	iName = aScheduleState2.Name();	
sl@0: 	iPersists = aScheduleState2.Persists();
sl@0: 	iEnabled = aScheduleState2.Enabled();
sl@0: 	
sl@0: 	// iDueTime is local time based for backwards compatibility
sl@0: 	iDueTime = aScheduleState2.DueTime().GetLocalTime();
sl@0: 	}