S60 3rd Edition API Reference: TSdpTypedTime Class Reference

TSdpTypedTime Class Reference

API published in: S60 2nd Ed

Link against: sdpcodec.lib

Capability Information

Required Capabilities

None

Exceptions

#include <sdptypedtime.h>

Detailed Description

PublishedAll
Released
This class implements the typed time element of the Session Description Protocol.

The normative reference for correct formatting and values is draft-ietf-mmusic-sdp-new-14 unless specified otherwise in member documentation. The implementation supports this normative reference, but does not enforce it fully.


Public Types

enum  TUnit {
  ETimeUnitDays, ETimeUnitHours, ETimeUnitMinutes, ETimeUnitSeconds,
  ETimeUnitNone
}
 Time units. More...

Public Member Functions

IMPORT_C TSdpTypedTime ()
 Constructs a typed time equal to zero and with no time unit set.
IMPORT_C TSdpTypedTime (TInt64 aValue, TUnit aUnit)
 Constructs a typed time equal to specified value and time unit.
IMPORT_C TBool operator== (const TSdpTypedTime &aObj) const
 Compares this instance to another for equality.
IMPORT_C void SetValue (TInt64 aValue, TUnit aUnit)
 Sets the typed time value.
void ExternalizeL (RWriteStream &aStream) const
 Externalizes the object to stream.
void EncodeL (RWriteStream &aStream) const
 Output the field formatted according to SDP syntax and including the terminating CRLF.

Static Public Member Functions

static TSdpTypedTime InternalizeL (RReadStream &aStream)
 Creates object from the stream data.
static TSdpTypedTime DecodeL (const TDesC8 &aText)
 Construct a new origin field.

Data Fields

TInt64 iValue
TInt iUnit

Member Enumeration Documentation

enum TSdpTypedTime::TUnit
 

Time units.

Enumerator:
ETimeUnitDays 
ETimeUnitHours  d
ETimeUnitMinutes  h
ETimeUnitSeconds  m
ETimeUnitNone  s

Constructor & Destructor Documentation

IMPORT_C TSdpTypedTime::TSdpTypedTime (   ) 
 

Constructs a typed time equal to zero and with no time unit set.

IMPORT_C TSdpTypedTime::TSdpTypedTime ( TInt64  aValue,
TUnit  aUnit
) 
 

Constructs a typed time equal to specified value and time unit.

Parameters:
aValue Time value.
aUnit Time unit.

Member Function Documentation

static TSdpTypedTime TSdpTypedTime::DecodeL ( const TDesC8 &  aText  )  [static]
 

Construct a new origin field.

Parameters:
aText A string containing a correctly formatted field value terminated by a CRLF.
Returns:
The new instance.
void TSdpTypedTime::EncodeL ( RWriteStream &  aStream  )  const
 

Output the field formatted according to SDP syntax and including the terminating CRLF.

Parameters:
aStream Stream used for output.
void TSdpTypedTime::ExternalizeL ( RWriteStream &  aStream  )  const
 

Externalizes the object to stream.

Parameters:
aStream Stream where the object's state will be stored
static TSdpTypedTime TSdpTypedTime::InternalizeL ( RReadStream &  aStream  )  [static]
 

Creates object from the stream data.

Parameters:
aStream Stream where the object's state will be read
Returns:
Initialized object
IMPORT_C TBool TSdpTypedTime::operator== ( const TSdpTypedTime &  aObj  )  const
 

Compares this instance to another for equality.

Parameters:
aObj Another instance to compare with.
Returns:
ETrue if equal, EFalse if not.
IMPORT_C void TSdpTypedTime::SetValue ( TInt64  aValue,
TUnit  aUnit
) 
 

Sets the typed time value.

Parameters:
aValue Time value.
aUnit Time unit.

Field Documentation

TInt TSdpTypedTime::iUnit
 
TInt64 TSdpTypedTime::iValue
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top