williamr@2: /*
williamr@2: * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name          : SdpTypedTime.h
williamr@2: * Part of       : SDP Codec
williamr@2: * Interface     : SDK API, SDP Codec API
williamr@2: * Version       : 1.0
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef TSDPTYPEDTIME_H
williamr@2: #define TSDPTYPEDTIME_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class RReadStream;
williamr@2: class RWriteStream;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2:  *  @publishedAll
williamr@2:  *  @released
williamr@2:  *
williamr@2:  *	This class implements the typed time element of the Session
williamr@2:  *	Description Protocol.
williamr@2:  *
williamr@2:  *	The normative reference for correct formatting and values is
williamr@2:  *	draft-ietf-mmusic-sdp-new-14 unless specified otherwise in
williamr@2:  *  member documentation. The implementation supports this normative
williamr@2:  *  reference, but does not enforce it fully. 
williamr@2:  *
williamr@2:  *  @lib sdpcodec.lib
williamr@2:  */
williamr@2: class TSdpTypedTime
williamr@2: 	{
williamr@2:     public: // enums
williamr@2: 
williamr@2:         /** Time units. */
williamr@2:         enum TUnit
williamr@2:             {
williamr@2:             ETimeUnitDays,      /** d */
williamr@2:             ETimeUnitHours,     /** h */
williamr@2: 		    ETimeUnitMinutes,   /** m */
williamr@2: 		    ETimeUnitSeconds,   /** s */
williamr@2: 		    ETimeUnitNone,
williamr@2:             };
williamr@2: 
williamr@2:     public: // Constructors and destructor
williamr@2: 		/**
williamr@2: 		 *	Constructs a typed time equal to zero and with no time unit set.
williamr@2: 		 */
williamr@2: 		IMPORT_C TSdpTypedTime();
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Constructs a typed time equal to specified value and time unit.
williamr@2: 		 *
williamr@2: 		 *	@param aValue Time value.
williamr@2: 		 *	@param aUnit Time unit.
williamr@2: 		 */
williamr@2: 		IMPORT_C TSdpTypedTime(TInt64 aValue, TUnit aUnit);
williamr@2: 
williamr@2:     public: // New functions
williamr@2: 		/**	
williamr@2: 		 *	Compares this instance to another for equality.
williamr@2: 		 *
williamr@2: 		 *	@param aObj Another instance to compare with.
williamr@2: 		 *	@return ETrue if equal, EFalse if not.
williamr@2: 		 */
williamr@2: 		IMPORT_C TBool operator == (const TSdpTypedTime& aObj) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Sets the typed time value.
williamr@2: 		 *
williamr@2: 		 *	@param aValue Time value.
williamr@2: 		 *	@param aUnit Time unit.
williamr@2: 		 */
williamr@2: 		IMPORT_C void SetValue(TInt64 aValue, TUnit aUnit);
williamr@2: 
williamr@2:     public:
williamr@2: 		
williamr@2: 		/**
williamr@2:          *  Externalizes the object to stream
williamr@2:          *
williamr@2:          *  @param aStream Stream where the object's state will be stored
williamr@2:          */
williamr@2: 		void ExternalizeL(RWriteStream& aStream) const;
williamr@2: 		
williamr@2: 		/**
williamr@2:          *  Creates object from the stream data
williamr@2:          *
williamr@2:          *  @param aStream Stream where the object's state will be read
williamr@2:          *  @return Initialized object
williamr@2:          */
williamr@2: 		static TSdpTypedTime InternalizeL(RReadStream& aStream);
williamr@2:         
williamr@2:         /**
williamr@2: 		 *	Output the field formatted according to SDP syntax and including
williamr@2: 		 *  the terminating CRLF.
williamr@2: 		 * 
williamr@2: 		 *	@param aStream	Stream used for output.
williamr@2: 		 */
williamr@2:         void EncodeL(RWriteStream& aStream) const;
williamr@2:         
williamr@2:         /**
williamr@2:          *	Construct a new origin field.
williamr@2: 		 *		 
williamr@2:          *	@param aText A string containing a correctly formatted field value
williamr@2: 		 *               terminated by a CRLF.
williamr@2:          *	@return The new instance.
williamr@2:          */
williamr@2:         static TSdpTypedTime DecodeL(const TDesC8& aText);
williamr@2: 
williamr@2:     public: // Data
williamr@2:     
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */
williamr@2: 		TInt64 iValue;
williamr@2: 		
williamr@2: 		/**
williamr@2: 		* @internalComponent
williamr@2: 		*/
williamr@2: 		TInt iUnit;
williamr@2: 
williamr@2: 	};
williamr@2: 
williamr@2: #endif // TSDPTYPEDTIME_H