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@2: * 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
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.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          : SdpBandwidthField.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 CSDPBANDWIDTHFIELD_H
williamr@2: #define CSDPBANDWIDTHFIELD_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32base.h>
williamr@2: #include <stringpool.h>
williamr@2: #include "_sdpdefs.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 encapsulates the bandwidth field of 
williamr@2:  *  the Session 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 CSdpBandwidthField : public CBase
williamr@2: 	{
williamr@2: 	public:// Constructors and destructor
williamr@2:        /**
williamr@2:          *	Constructs a new bandwidth field.
williamr@2: 		 *	
williamr@2:          *	@param aText A string containing a correctly 
williamr@2:          *         formatted field value terminated by a CRLF.
williamr@2:          *	@return a new instance.
williamr@2:          */
williamr@2: 		IMPORT_C static CSdpBandwidthField* DecodeL(const TDesC8& aText);
williamr@2: 
williamr@2:          /**
williamr@2:          *	Constructs a new bandwidth field and adds the pointer to the 
williamr@2:          *  cleanup stack.
williamr@2: 		 *	
williamr@2:          *	@param aText A string containing a correctly 
williamr@2:          *         formatted field value terminated by a CRLF.
williamr@2:          *	@return a new instance.
williamr@2:          */
williamr@2: 		IMPORT_C static CSdpBandwidthField* DecodeLC(const TDesC8& aText);
williamr@2: 
williamr@2:         /**
williamr@2:          *	Constructs a new bandwidth field.
williamr@2: 		 *
williamr@2:          *	@param aModifier Bandwidth modifier.
williamr@2: 		 *  @param aValue Bandwidth value.
williamr@2:          *	@return a new instance.
williamr@2: 		 */
williamr@2: 		IMPORT_C static CSdpBandwidthField* NewL(RStringF aModifier,
williamr@2: 												 TUint32 aValue);
williamr@2: 
williamr@2:         /**
williamr@2:          *	Constructs a new bandwidth field and adds the pointer to the 
williamr@2:          *  cleanup stack.
williamr@2: 		 *
williamr@2:          *	@param aModifier Bandwidth modifier.
williamr@2: 		 *  @param aValue Bandwidth value.
williamr@2:          *	@return a new instance.
williamr@2: 		 */
williamr@2: 		IMPORT_C static CSdpBandwidthField* NewLC(RStringF aModifier,
williamr@2: 												  TUint32 aValue);
williamr@2: 
williamr@2:  
williamr@2:         /**
williamr@2: 		 *	Deletes the resources held by the instance.
williamr@2: 		 */
williamr@2: 		IMPORT_C ~CSdpBandwidthField();
williamr@2: 
williamr@2:     public: // New functions
williamr@2: 		/**
williamr@2: 		 *	Outputs the field formatted according to SDP syntax and including
williamr@2: 		 *  the terminating CRLF.
williamr@2: 		 * 
williamr@2: 		 *	@param aStream Stream used for output. On return 
williamr@2:          *         the stream includes correctly formatted bandwidth field.
williamr@2: 		 */
williamr@2: 		IMPORT_C void EncodeL(RWriteStream& aStream) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Creates a new instance that is equal to the target.
williamr@2: 		 *
williamr@2: 		 *	@return a new instance.
williamr@2: 		 */
williamr@2: 		IMPORT_C CSdpBandwidthField * CloneL() const;
williamr@2: 
williamr@2: 		/**	
williamr@2: 		 *	Compares this instance to another for equality.
williamr@2: 		 *
williamr@2: 		 *	@param aObj The instance to compare to.
williamr@2: 		 *	@return ETrue if equal, EFalse if not.
williamr@2: 		 */
williamr@2: 		IMPORT_C TBool operator == (const CSdpBandwidthField& aObj) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Gets the bandwidth modifier.
williamr@2: 		 *
williamr@2: 		 *	@return The modifier that can be pre-defined in the 
williamr@2: 		 *          SDP string table or defined by the user.
williamr@2: 		 */
williamr@2: 		IMPORT_C RStringF Modifier() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Sets the bandwidth modifier.
williamr@2: 		 *
williamr@2:          *	@param aModifier A valid bandwidth modifier name.
williamr@2: 		 */
williamr@2: 		IMPORT_C void SetModifier(RStringF aModifier);
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Gets the bandwidth value.
williamr@2: 		 *
williamr@2: 		 *	@return The value.
williamr@2: 		 */
williamr@2: 		IMPORT_C TUint32 Value() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Sets the bandwidth value.
williamr@2: 		 *
williamr@2: 		 *	@param aValue The Value.
williamr@2: 		 */
williamr@2: 		IMPORT_C void SetValue(TUint32 aValue);
williamr@2: 
williamr@2:     public:
williamr@2: 		/**
williamr@2: 		 *	Externalize the instance in a memory optimized format.
williamr@2: 		 *
williamr@2: 		 *	@param aStream The stream used for externalization.
williamr@2: 		 */
williamr@2: 		void ExternalizeL(RWriteStream& aStream) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		 *	Create a new instance from value created with ExternalizeL().
williamr@2: 		 *
williamr@2: 		 *	@param aStream The stream used for internalization.
williamr@2: 		 *	@return	The new instance.
williamr@2: 		 */
williamr@2:         static CSdpBandwidthField* InternalizeL(RReadStream& aStream);
williamr@2: 
williamr@2:     private:
williamr@2:         CSdpBandwidthField();
williamr@2: 		void ConstructL(const TDesC8& aText);
williamr@2: 		void ConstructL(RStringF aModifier, TUint32 aValue);
williamr@2: 		void ConstructL(const TDesC8& aModifier, TUint32 aValue);
williamr@2: 
williamr@2:         /**
williamr@2:          *  Copies given modifier to iModifier. If aModifier is none of 
williamr@2:          *  predefined ones, new modifier is added to stringPool.
williamr@2:          *
williamr@2:          *  @param aModifier Given modifier
williamr@2:          */
williamr@2:         void CopyModifierL(const TDesC8& aModifier);
williamr@2: 
williamr@2:     private: // Data
williamr@2: 		RStringF iModifier;
williamr@2:         TUint32 iValue;
williamr@2:         RStringPool iStringPool;
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSDPBANDWIDTHFIELD_H