CSmsCommand Class Reference

#include <gsmupdu.h>

Link against: gsmu.lib

class CSmsCommand : public CSmsPDU

Inherits from

Public Member Functions
CSmsCommand()
~CSmsCommand()
IMPORT_C voidAddInformationElementL(CSmsInformationElement::TSmsInformationElementIdentifier, TDesC8 &)
IMPORT_C TPtrC8CommandData()
IMPORT_C TIntCommandType()
IMPORT_C CSmsCommand *DuplicateL()
IMPORT_C CSmsInformationElement &InformationElement(TInt)
IMPORT_C TBoolInformationElementIndex(CSmsInformationElement::TSmsInformationElementIdentifier, TInt &)
CSmsInformationElement *&InformationElementPtr(TInt)
IMPORT_C TIntMaxCommandDataLength()
IMPORT_C TIntMessageNumber()
IMPORT_C TIntMessageReference()
IMPORT_C TIntNumInformationElements()
IMPORT_C voidRemoveInformationElement(TInt)
IMPORT_C voidSetCommandDataL(const TDesC8 &)
IMPORT_C voidSetCommandType(TSmsCommandType::TSmsCommandTypeValue)
IMPORT_C voidSetMessageNumber(TInt)
IMPORT_C voidSetMessageReference(TInt)
IMPORT_C voidSetStatusReportRequest(TBool)
IMPORT_C TBoolStatusReportRequest()
Protected Member Functions
virtual voidConstructL(CCnvCharacterSetConverter &, RFs &)
virtual voidDecodeL(TGsmuLex8 &)
voidDoSetStatusReportRequest(TBool)
virtual TUint8 *EncodeL(TUint8 *)
virtual TUint8 *EncodeL(TUint8 *, const TEncodeParams *)
virtual voidExternalizeMessagePDUL(RWriteStream &)
virtual voidInternalizeMessagePDUL(RReadStream &)
virtual const TSmsProtocolIdentifier *ProtocolIdentifier()
virtual const CSmsAddress *ToFromAddressPtr()
Inherited Attributes
CSmsPDU::iServiceCenterAddress
Inherited Enumerations
CSmsPDU:TSmsPDUType
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CSmsPDU::Alphabet()const
CSmsPDU::ApplicationPortAddressing(TInt &,TInt &,TBool *)const
CSmsPDU::Bits7To4()const
CSmsPDU::CSmsPDU(TSmsPDUType)
CSmsPDU::Class(TSmsDataCodingScheme::TSmsClass &)const
CSmsPDU::ConcatenatedMessagePDUIndex()const
CSmsPDU::ConcatenatedMessageReference()const
CSmsPDU::DataCodingScheme()const
CSmsPDU::DataCodingSchemePresent()const
CSmsPDU::EncodeMessagePDUL(TGsmSms &)const
CSmsPDU::EncodeMessagePDUL(TGsmSms &,const TEncodeParams *)const
CSmsPDU::ExternalizeL(RWriteStream &)const
CSmsPDU::IndicationState()const
CSmsPDU::IndicationType()const
CSmsPDU::NationalLanguageEncoding()const
CSmsPDU::NewL(RReadStream &,CCnvCharacterSetConverter &,RFs &)
CSmsPDU::NewL(TSmsPDUType,CCnvCharacterSetConverter &,RFs &,TBool)
CSmsPDU::NewL(const TGsmSms &,CCnvCharacterSetConverter &,RFs &,TBool,TBool)
CSmsPDU::NumConcatenatedMessagePDUs()const
CSmsPDU::PIDType()const
CSmsPDU::ParameterIndicator()const
CSmsPDU::ParsedServiceCenterAddress(TGsmSmsTelNumber &)const
CSmsPDU::ParsedToFromAddress(TGsmSmsTelNumber &)const
CSmsPDU::ProtocolIdentifierPresent()const
CSmsPDU::ServiceCenterAddress()const
CSmsPDU::SetAlphabet(TSmsDataCodingScheme::TSmsAlphabet)
CSmsPDU::SetApplicationPortAddressingL(TBool,TInt,TInt,TBool)
CSmsPDU::SetBits7To4(TSmsDataCodingScheme::TSmsDCSBits7To4)
CSmsPDU::SetClass(TBool,TSmsDataCodingScheme::TSmsClass)
CSmsPDU::SetConcatenatedMessagePDUIndex(TInt)
CSmsPDU::SetConcatenatedMessageReference(TInt)
CSmsPDU::SetDataCodingSchemePresent(TBool)
CSmsPDU::SetIndicationState(TSmsDataCodingScheme::TSmsIndicationState)
CSmsPDU::SetIndicationType(TSmsDataCodingScheme::TSmsIndicationType)
CSmsPDU::SetNationalLanguageEncodingL(TSmsEncoding)
CSmsPDU::SetNumConcatenatedMessagePDUs(TInt)
CSmsPDU::SetPIDType(TSmsProtocolIdentifier::TSmsPIDType)
CSmsPDU::SetParsedServiceCenterAddressL(const TGsmSmsTelNumber &)
CSmsPDU::SetParsedToFromAddressL(const TGsmSmsTelNumber &)
CSmsPDU::SetProtocolIdentifierPresent(TBool)
CSmsPDU::SetServiceCenterAddressL(const TDesC &)
CSmsPDU::SetShortMessageType(TSmsProtocolIdentifier::TSmsShortMessageType)
CSmsPDU::SetTelematicDeviceIndicator(TSmsProtocolIdentifier::TSmsTelematicDeviceIndicator)
CSmsPDU::SetTelematicDeviceType(TSmsProtocolIdentifier::TSmsTelematicDeviceType)
CSmsPDU::SetTextCompressed(TBool)
CSmsPDU::SetTextConcatenatedL(TBool,TBool)
CSmsPDU::SetToFromAddressL(const TDesC &)
CSmsPDU::SetUserDataPresent(TBool)
CSmsPDU::ShortMessageType()const
CSmsPDU::TelematicDeviceIndicator()const
CSmsPDU::TelematicDeviceType()const
CSmsPDU::TextCompressed()const
CSmsPDU::TextConcatenated(TBool *)const
CSmsPDU::ToFromAddress()const
CSmsPDU::Type()const
CSmsPDU::UpdateConcatenationDataL(TInt,TInt,TInt)
CSmsPDU::UpdateEmailHeaderDataL(TInt &)
CSmsPDU::UpdateSMSCCtrlParameterL(const TUint8)
CSmsPDU::UpdateTPSRRL(TSmsFirstOctet)
CSmsPDU::UserData()
CSmsPDU::UserData()const
CSmsPDU::UserDataPresent()const
CSmsPDU::UserDataPtr()const

Detailed Description

SMS-COMMAND PDU - MS to SC

Constructor & Destructor Documentation

CSmsCommand ( )

CSmsCommand()

~CSmsCommand ( )

~CSmsCommand()

Destructor.

Member Function Documentation

AddInformationElementL ( CSmsInformationElement::TSmsInformationElementIdentifier, TDesC8 & )

IMPORT_C voidAddInformationElementL(CSmsInformationElement::TSmsInformationElementIdentifieraIdentifier,
TDesC8 &aData
)

Adds an Information Element.

Parameters
aIdentifierInformation Element Identifier to add
aDataThe Information Element data
Capability
None

CommandData ( )

IMPORT_C TPtrC8CommandData()const

Gets the Command Data.

Return Value
The Command Data
Capability
None

CommandType ( )

IMPORT_C TIntCommandType()const

Gets the Command Type.

Return Value
Command Type
Capability
None

ConstructL ( CCnvCharacterSetConverter &, RFs & )

voidConstructL(CCnvCharacterSetConverter &aCharacterSetConverter,
RFs &aFs
)[protected, virtual]

DecodeL ( TGsmuLex8 & )

voidDecodeL(TGsmuLex8 &aPdu)[protected, virtual]

DoSetStatusReportRequest ( TBool )

voidDoSetStatusReportRequest(TBoolaRequest)[protected]

DuplicateL ( )

IMPORT_C CSmsCommand *DuplicateL()const

Reimplemented from CSmsPDU::DuplicateL()const

Duplicates this CSmsCommand object.

Return Value
Pointer to the newly created CSmsCommand object.

EncodeL ( TUint8 * )

TUint8 *EncodeL(TUint8 *aPtr)const [protected, virtual]

EncodeL ( TUint8 *, const TEncodeParams * )

TUint8 *EncodeL(TUint8 *aPtr,
const TEncodeParams *aEncodeParams
)const [protected, virtual]

ExternalizeMessagePDUL ( RWriteStream & )

voidExternalizeMessagePDUL(RWriteStream &aStream)const [protected, virtual]

InformationElement ( TInt )

IMPORT_C CSmsInformationElement &InformationElement(TIntaIndex)const

Gets an Information Element.

Parameters
aIndexThe Information Element Index within the PDU
Return Value
Information Element
Capability
None

InformationElementIndex ( CSmsInformationElement::TSmsInformationElementIdentifier, TInt & )

IMPORT_C TBoolInformationElementIndex(CSmsInformationElement::TSmsInformationElementIdentifieraIdentifier,
TInt &aIndex
)const

Gets index of a specified Information Element.

Parameters
aIdentifierInformation Element Identifier to match
aIndexOn return, index of the Information Element matching aIdentifier
Return Value
True if Information Element present matching aIdentifier
Capability
None

InformationElementPtr ( TInt )

CSmsInformationElement *&InformationElementPtr(TIntaIndex)const

Gets a pointer to the Information Element located at aIndex.

Parameters
aIndexThe Information Element Index within the PDU
Return Value
Pointer to Information Element
Capability
None

InternalizeMessagePDUL ( RReadStream & )

voidInternalizeMessagePDUL(RReadStream &aStream)[protected, virtual]

MaxCommandDataLength ( )

IMPORT_C TIntMaxCommandDataLength()const

Gets the Maximum Data Length of the Command.

Return Value
Maximum Data Length of the Command
Capability
None

MessageNumber ( )

IMPORT_C TIntMessageNumber()const

Gets the Message Number.

Return Value
Message Number
Capability
None

MessageReference ( )

IMPORT_C TIntMessageReference()const

Gets the Message Reference.

Return Value
Message Reference
Capability
None

NumInformationElements ( )

IMPORT_C TIntNumInformationElements()const

Gets the number of Information Elements in the User Data.

Return Value
Number of Information Elements in the User Data
Capability
None

ProtocolIdentifier ( )

const TSmsProtocolIdentifier *ProtocolIdentifier()const [protected, virtual]

RemoveInformationElement ( TInt )

IMPORT_C voidRemoveInformationElement(TIntaIndex)

Removes an Information Element.

Parameters
aIndexIndex of the Information Element to be removed
Capability
None

SetCommandDataL ( const TDesC8 & )

IMPORT_C voidSetCommandDataL(const TDesC8 &aData)

Sets the Command Data.

Parameters
aDataThe Command Data
Capability
None

SetCommandType ( TSmsCommandType::TSmsCommandTypeValue )

IMPORT_C voidSetCommandType(TSmsCommandType::TSmsCommandTypeValueaCommandType)

Sets the Command Type.

Parameters
aCommandTypeCommand Type
Capability
None

SetMessageNumber ( TInt )

IMPORT_C voidSetMessageNumber(TIntaMessageNumber)

Sets the Message Number.

Parameters
aMessageNumberMessage Number
Capability
None

SetMessageReference ( TInt )

IMPORT_C voidSetMessageReference(TIntaMessageReference)

Sets the Message Reference.

Parameters
aMessageReferenceMessage Reference
Capability
None

SetStatusReportRequest ( TBool )

IMPORT_C voidSetStatusReportRequest(TBoolaRequest)

Sets Status Report Request flag.

Parameters
aRequestSet to True to Request Status Report
Capability
None

StatusReportRequest ( )

IMPORT_C TBoolStatusReportRequest()const

Gets Status Report Request flag.

Return Value
True if the sender is requesting Status Reports
Capability
None

ToFromAddressPtr ( )

const CSmsAddress *ToFromAddressPtr()const [protected, virtual]