CSmsSMSCCtrlParameterOperations Class Reference

#include "gsmuieoperations.h"

class CSmsSMSCCtrlParameterOperations : public CSmsCtrlOperation

Inherits from

CSmsSMSCCtrlParameterOperations
- CSmsCtrlOperation
  - CSmsIEOperation

Public Member Functions
	CSmsSMSCCtrlParameterOperations(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &)
	~CSmsSMSCCtrlParameterOperations()
IMPORT_C TSmsStatusReportScheme	GetScheme()
IMPORT_C TInt	GetStatusReport(TUint, TUint8 &)
IMPORT_C void	ResetSchemeL()
IMPORT_C void	SetDefaultL(TUint8)
IMPORT_C void	SetSchemeL()
IMPORT_C TInt	SetStatusReportL(TUint, TUint8)

Protected Member Functions
TBool	ValidateControlParametersL(TUint8 &)
virtual void	ValidateOperationL()
void	operator=(const CSmsSMSCCtrlParameterOperations &)
TBool	operator==(const CSmsSMSCCtrlParameterOperations &)

Inherited Attributes
	CSmsIEOperation::iMessage

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()
	CSmsCtrlOperation::CSmsCtrlOperation(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &)
	CSmsCtrlOperation::operator=(const CSmsCtrlOperation &)
	CSmsCtrlOperation::operator==(const CSmsCtrlOperation &)
	CSmsCtrlOperation::~CSmsCtrlOperation()
	CSmsIEOperation::CSmsIEOperation(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &)
	CSmsIEOperation::Id()const
	CSmsIEOperation::MessageTypeSupported()const
	CSmsIEOperation::NewL(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &,CCnvCharacterSetConverter &,RFs &)
	CSmsIEOperation::operator=(const CSmsIEOperation &)
	CSmsIEOperation::operator==(const CSmsIEOperation &)
	CSmsIEOperation::~CSmsIEOperation()

Constructor & Destructor Documentation

CSmsSMSCCtrlParameterOperations ( CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage & )

CSmsSMSCCtrlParameterOperations	(	CSmsInformationElement::TSmsInformationElementIdentifier	aId,
		CSmsMessage &	aMessage
	)

~CSmsSMSCCtrlParameterOperations ( )

~CSmsSMSCCtrlParameterOperations

(

)

[inline]

Member Function Documentation

GetScheme ( )

IMPORT_C TSmsStatusReportScheme

GetScheme

(

)

const

Gets the current scheme being used.

capability: None

Returns: EControlParametrsScheme is returned when Control Parameters Scheme is being used.

GetStatusReport ( TUint, TUint8 & )

IMPORT_C TInt	GetStatusReport	(	TUint	aSegmentSequenceNum,
			TUint8 &	aSelectiveStatus
		)	const

Gets the selective status for a PDU if the scheme is set to the Control Parameters Scheme.

capability: None

Parameter	Description
aSegmentSequenceNum	The segment sequence number of the PDU whose status report is required.
aSelectiveStatus	Returns the selective status octet for that PDU.

Returns: KErrNotFound if the segment sequence number or the scheme is invalid.

ResetSchemeL ( )

IMPORT_C void

ResetSchemeL

(

)

This method re-sets the scheme to the Default Scheme.

capability: None

SetDefaultL ( TUint8 )

IMPORT_C void

SetDefaultL

(

TUint8

aDefaultSelectiveStatus

)

Sets the default value of the status report to aDefaultSelectiveStatus.

leave: KErrNotFound If the scheme is invalid.

capability: None

Parameter	Description
aDefaultSelectiveStatus	The selective status to be used as default.

SetSchemeL ( )

IMPORT_C void

SetSchemeL

(

)

This method is called to set the scheme to Control Parameters Scheme. First iStatusReportScheme, which is obtained by calling GetStatusReportScheme, is deleted and set to NULL. Then a new scheme is created and a default value is set. This should be the last method to be called in a message sending process as all the operations in this interface depend on the number of PDUs being set.

leave

If ValidateOperationL or NumMessagePDUsL leaves.

capability: None

SetStatusReportL ( TUint, TUint8 )

IMPORT_C TInt	SetStatusReportL	(	TUint	aSegmentSequenceNum,
			TUint8	aSelectiveStatus
		)

Sets the status report for a PDU. First the scheme is obtained by calling the GetStatusReportScheme and checked if it is the valid scheme. Then aSelectiveStatus is checked to see if it is the default value. If it is then nothing is done. But if aSelectiveStatus is non-default then it is appended to the array iControlParametersStatusReport along with the aSegmentSequenceNum

leave

If ValidateOperationL or AppendL leaves.

capability: None

Parameter	Description
aSegmentSequenceNum	The segment sequence number of the PDU which needs to be updated.
aSelectiveStatus	The octet which needs to be set as the Selective Status for the report.

Returns: KErrNone if the operation is successful. KErrNotFound if the Segment Sequence Number is out of range or the scheme is inavlid. KErrNotSupported if aSelectiveStatus is not valid.

ValidateControlParametersL ( TUint8 & )

TBool

ValidateControlParametersL

(

TUint8 &

aSelectiveStatus

)

const [protected]

Checks that the octet passed to it has the valid bits set in it. If the bits which are not supported yet are set then reset it. This method is called by SetStatusReportL.

leave: KErrNotSupported If the last 4 bits are set as they are not supported.

Parameter	Description
aSelectiveStatus	The octet which needs to be set as the Selective Status for the report.

Returns: ETrue if the selective status is valid.

ValidateOperationL ( )

void

ValidateOperationL

(

)

const [protected, virtual]

Reimplemented from CSmsIEOperation::ValidateOperationL()const

Identifies whether the message type or version supports this operation

leave

If the message type or version does not support this operation.

operator= ( const CSmsSMSCCtrlParameterOperations & )

void

operator=

(

const CSmsSMSCCtrlParameterOperations &

)

[protected]

Prevent clients from using the assignment operator by including it in the class definition but making it protected and not exporting it.

capability: None

operator== ( const CSmsSMSCCtrlParameterOperations & )

TBool

operator==

(

const CSmsSMSCCtrlParameterOperations &

)

[protected]

Prevent clients from using the equality operator by including it in the class definition but making it protected and not exporting it.

capability: None