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 : SdpRepeatField.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 CSDPREPEATFIELD_H williamr@2: #define CSDPREPEATFIELD_H williamr@2: williamr@2: // INCLUDES williamr@2: #include williamr@2: #include williamr@2: #include 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 repeat times field of the williamr@2: * 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 CSdpRepeatField : public CBase williamr@2: { williamr@2: public: // Constructors and destructor williamr@2: /** williamr@2: * Constructs a new repeat times 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 CSdpRepeatField* DecodeL(const TDesC8& aText); williamr@2: williamr@2: /** williamr@2: * Constructs a new repeat times 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 CSdpRepeatField* DecodeLC(const TDesC8& aText); williamr@2: williamr@2: /** williamr@2: * Constructs a new repeat times field. williamr@2: * williamr@2: * @param aRepeatInterval Repeat interval value williamr@2: * greater than zero. williamr@2: * @param aActiveDuration Active duration. williamr@2: * @param aOffsets At least one time offset. williamr@2: * @return a new instance. williamr@2: */ williamr@2: IMPORT_C static CSdpRepeatField* NewL( williamr@2: const TSdpTypedTime aRepeatInterval, williamr@2: const TSdpTypedTime aActiveDuration, williamr@2: const RArray& aOffsets); williamr@2: williamr@2: /** williamr@2: * Constructs a new repeat times field and adds the pointer to the williamr@2: * cleanup stack. williamr@2: * williamr@2: * @param aRepeatInterval Repeat interval value williamr@2: * greater than zero. williamr@2: * @param aActiveDuration Active duration. williamr@2: * @param aOffsets At least one time offset. williamr@2: * @return a new instance. williamr@2: */ williamr@2: IMPORT_C static CSdpRepeatField* NewLC( williamr@2: const TSdpTypedTime aRepeatInterval, williamr@2: const TSdpTypedTime aActiveDuration, williamr@2: const RArray& aOffsets); williamr@2: williamr@2: /** williamr@2: * Deletes the resources held by the instance. williamr@2: */ williamr@2: IMPORT_C ~CSdpRepeatField(); 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 repeat 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 CSdpRepeatField * 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 CSdpRepeatField & aObj) const; williamr@2: williamr@2: /** williamr@2: * Gets the repeat interval. williamr@2: * williamr@2: * @return The repeat interval. williamr@2: */ williamr@2: IMPORT_C const TSdpTypedTime RepeatInterval() const; williamr@2: williamr@2: /** williamr@2: * Sets the repeat interval. williamr@2: * williamr@2: * @param aValue Repeat interval value greater than zero. williamr@2: * @leave KErrSdpCodecRepeatField if aValue is not positive integer williamr@2: * value. williamr@2: */ williamr@2: IMPORT_C void SetRepeatIntervalL(const TSdpTypedTime aValue); williamr@2: williamr@2: /** williamr@2: * Gets the active duration.. williamr@2: * williamr@2: * @return The active duration. williamr@2: */ williamr@2: IMPORT_C const TSdpTypedTime ActiveDuration() const; williamr@2: williamr@2: /** williamr@2: * Sets the active duration. williamr@2: * williamr@2: * @param Active duration. williamr@2: */ williamr@2: IMPORT_C void SetActiveDuration(const TSdpTypedTime aValue); williamr@2: williamr@2: /** williamr@2: * Gets the array of time offsets. williamr@2: * This array is used directly for element insertion and removal. williamr@2: * williamr@2: * @return The offsets. williamr@2: */ williamr@2: IMPORT_C const RArray& TimeOffsets() const; williamr@2: williamr@2: /** williamr@2: * Sets the time offsets. williamr@2: * williamr@2: * @param aOffsets At least one time offset. williamr@2: */ williamr@2: IMPORT_C void SetTimeOffsetsL(const RArray& aValue); williamr@2: williamr@2: public: 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 CSdpRepeatField* InternalizeL(RReadStream& aStream); williamr@2: williamr@2: private: williamr@2: CSdpRepeatField(const TSdpTypedTime aRepeatInterval, williamr@2: const TSdpTypedTime aActiveDuration); williamr@2: CSdpRepeatField(); williamr@2: void ConstructL(const TDesC8& aText); williamr@2: void ConstructL(const RArray& aOffsets); williamr@2: williamr@2: williamr@2: private: // Data williamr@2: RStringPool iPool; williamr@2: TSdpTypedTime iRepeatInterval; williamr@2: TSdpTypedTime iActiveDuration; williamr@2: RArray iTimeOffsets; williamr@2: williamr@4: void __DbgTestInvariant() const; williamr@4: williamr@2: }; williamr@2: williamr@2: #endif // CSDPREPEATFIELD_H