Symbian^3 Application Developer Library >

CMTPParserRouter::CMap Class Reference

class CMTPParserRouter::CMap : public CBase

Implements a generic, multi-parameter routing table data structure. This table implements owns EITHER:

1. A container of TMap node objects if implementing a single parameter table or the final level (n) of a multi-parameter table, OR; 2. A container of CMap branch objects if implementing an intermediate level (1 .. n-1) of a multi-parameter table.

Inherits from

Public Member Functions
~CMap ()
TUint From ()
void GetToL (const RArray < TUint > &, RArray < TUint > &)
void InitParamsL ( RArray < TUint > &)
void InsertL (const RArray < TUint > &, TUint )
CMap * NewLC ( TUint )
TUint SubType ()
Private Member Functions
CMap ( TUint , TUint )
TInt BranchFind ( TUint )
TUint BranchInsertL ( TUint )
TInt BranchOrderFromAscending (const CMap &, const CMap &)
TInt BranchOrderFromDescending (const CMap &, const CMap &)
TInt BranchOrderFromKeyAscending (const TUint *, const CMap &)
TInt BranchOrderFromKeyDescending (const TUint *, const CMap &)
void ConstructL ()
CMap * NewLC ( TUint , TUint )
TInt NodeFind ( TUint )
TInt NodeFind (const TMap &)
TUint NodeInsertL (const TMap &)
TInt NodeOrderFromAscending (const TMap &, const TMap &)
TInt NodeOrderFromDescending (const TMap &, const TMap &)
TInt NodeOrderFromKeyAscending (const TUint *, const TMap &)
TInt NodeOrderFromKeyDescending (const TUint *, const TMap &)
TInt NodeOrderFromToAscending (const TMap &, const TMap &)
TInt NodeOrderFromToDescending (const TMap &, const TMap &)
TUint Param (const RArray < TUint > &)
TUint ParamIdx (const RArray < TUint > &)
void SelectTargetAllL (const RArray < TUint > &, RArray < TUint > &)
void SelectTargetMatchingL (const RArray < TUint > &, RArray < TUint > &)
void SelectTargetSingleL (const RArray < TUint > &, RArray < TUint > &)
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()
Private Attributes
__FLOG_DECLARATION_MEMBER_MUTABLE
TUint iFrom
TUint iSubType
RPointerArray < CMap > iToBranches
RArray < TMap > iToNodes

Constructor & Destructor Documentation

CMap(TUint, TUint)

CMap ( TUint aFrom,
TUint aSubType
) [private]

Constructor.

Parameters

TUint aFrom The map source parameter.
TUint aSubType

~CMap()

~CMap ( )

Destructor.

Member Functions Documentation

BranchFind(TUint)

TInt BranchFind ( TUint aFrom ) const [private]

Locates the map branch table index of the first map table entry matching the specified source parameter, using a binary search algorithm.

Parameters

TUint aFrom The map source parameter,

BranchInsertL(TUint)

TUint BranchInsertL ( TUint aFrom ) [private]
Inserts a new map branch table with the specified source parameter.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

TUint aFrom The map source paramete.

BranchOrderFromAscending(const CMap &, const CMap &)

TInt BranchOrderFromAscending ( const CMap & aL,
const CMap & aR
) [private, static]

Implements an TLinearOrder relation for CMTPParserRouter::CMap branch map objects based on ascending map source parameter order.

Parameters

const CMap & aL The first object instance.
const CMap & aR The second object instance.

BranchOrderFromDescending(const CMap &, const CMap &)

TInt BranchOrderFromDescending ( const CMap & aL,
const CMap & aR
) [private, static]

Implements an TLinearOrder relation for CMTPParserRouter::CMap branch map objects based on descending map source parameter order.

Parameters

const CMap & aL The first object instance.
const CMap & aR The second object instance.

BranchOrderFromKeyAscending(const TUint *, const CMap &)

TInt BranchOrderFromKeyAscending ( const TUint * aL,
const CMap & aR
) [private, static]

Implements a map source parameter key identity relation for CMTPParserRouter::CMap branch map objects based on ascending key order.

Parameters

const TUint * aL The first object instance.
const CMap & aR The second object instance.

BranchOrderFromKeyDescending(const TUint *, const CMap &)

TInt BranchOrderFromKeyDescending ( const TUint * aL,
const CMap & aR
) [private, static]

Implements a map source parameter key identity relation for CMTPParserRouter::CMap branch map objects based on descending key order.

Parameters

const TUint * aL The first object instance.
const CMap & aR The second object instance.

ConstructL()

void ConstructL ( ) [private]

Second-phase constructor.

From()

TUint From ( ) const

Provides the map source parameter.

GetToL(const RArray< TUint > &, RArray< TUint > &)

void GetToL ( const RArray < TUint > & aFrom,
RArray < TUint > & aTo
) const
Provides the set of targets which map from the specified source parameters.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

const RArray < TUint > & aFrom The map source parameters.
RArray < TUint > & aTo The map target parameter set.

InitParamsL(RArray< TUint > &)

void InitParamsL ( RArray < TUint > & aFrom ) const
Initialises a map source parameter set array.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

RArray < TUint > & aFrom On exit, the initialised map source parameter set array.

InsertL(const RArray< TUint > &, TUint)

void InsertL ( const RArray < TUint > & aFrom,
TUint aTo
)
Inserts an entry into the map table with the specified source and target parameters.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

const RArray < TUint > & aFrom The map target parameter.
TUint aTo

NewLC(TUint)

CMap * NewLC ( TUint aSubType ) [static]
CMTPParserRouter::CMap factory method. CMTPParserRouter::TRoutingSubType ).
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

TUint aSubType The map routing sub-type code (

NewLC(TUint, TUint)

CMap * NewLC ( TUint aFrom,
TUint aSubType
) [private, static]
CMTPParserRouter::CMap factory method.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

TUint aFrom The map source parameter.
TUint aSubType

NodeFind(TUint)

TInt NodeFind ( TUint aFrom ) const [private]

Locates the map node table index of the first map table entry matching the specified source parameter, using a binary search algorithm.

Parameters

TUint aFrom The source parameter,

NodeFind(const TMap &)

TInt NodeFind ( const TMap & aNode ) const [private]

Locates the map node table index of the map table entry matching the specified node, using a binary search algorithm.

Parameters

const TMap & aNode

NodeInsertL(const TMap &)

TUint NodeInsertL ( const TMap & aMap ) [private]
Inserts the specified map node into the map node table.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

const TMap & aMap

NodeOrderFromAscending(const TMap &, const TMap &)

TInt NodeOrderFromAscending ( const TMap & aL,
const TMap & aR
) [private, static]

Implements an TLinearOrder relation for CMTPParserRouter::TMap node map objects based on ascending map source parameter order.

Parameters

const TMap & aL The first object instance.
const TMap & aR The second object instance.

NodeOrderFromDescending(const TMap &, const TMap &)

TInt NodeOrderFromDescending ( const TMap & aL,
const TMap & aR
) [private, static]

Implements an TLinearOrder relation for CMTPParserRouter::TMap node map objects based on descending map source parameter order.

Parameters

const TMap & aL The first object instance.
const TMap & aR The second object instance.

NodeOrderFromKeyAscending(const TUint *, const TMap &)

TInt NodeOrderFromKeyAscending ( const TUint * aL,
const TMap & aR
) [private, static]

Implements a map source parameter key identity relation for CMTPParserRouter::TMap node map objects based on ascending key order.

Parameters

const TUint * aL The first object instance.
const TMap & aR The second object instance.

NodeOrderFromKeyDescending(const TUint *, const TMap &)

TInt NodeOrderFromKeyDescending ( const TUint * aL,
const TMap & aR
) [private, static]

Implements a map source parameter key identity relation for CMTPParserRouter::TMap node map objects based on descending key order.

Parameters

const TUint * aL The first object instance.
const TMap & aR The second object instance.

NodeOrderFromToAscending(const TMap &, const TMap &)

TInt NodeOrderFromToAscending ( const TMap & aL,
const TMap & aR
) [private, static]

Implements an TLinearOrder relation for CMTPParserRouter::CMap branch map objects based on ascending map source and target parameter order.

Parameters

const TMap & aL The first object instance.
const TMap & aR The second object instance.

NodeOrderFromToDescending(const TMap &, const TMap &)

TInt NodeOrderFromToDescending ( const TMap & aL,
const TMap & aR
) [private, static]

Implements an TLinearOrder relation for CMTPParserRouter::CMap branch map objects based on descending map source and target parameter order.

Parameters

const TMap & aL The first object instance.
const TMap & aR The second object instance.

Param(const RArray< TUint > &)

TUint Param ( const RArray < TUint > & aFrom ) const [private]

Provides the source parameter value from the specified source parameter set appropriate to the parameter level of the map.

Parameters

const RArray < TUint > & aFrom The map source parameter set.

ParamIdx(const RArray< TUint > &)

TUint ParamIdx ( const RArray < TUint > & aFrom ) const [private]

Provides the source parameter set index of the source parameter corresponding to the parameter level of the map.

Parameters

const RArray < TUint > & aFrom The map source parameter set.

SelectTargetAllL(const RArray< TUint > &, RArray< TUint > &)

void SelectTargetAllL ( const RArray < TUint > & aFrom,
RArray < TUint > & aTo
) const [private]
Selects all map targets at the parameter level of the map.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

const RArray < TUint > & aFrom The map source parameter set.
RArray < TUint > & aTo The matching target parameters.

SelectTargetMatchingL(const RArray< TUint > &, RArray< TUint > &)

void SelectTargetMatchingL ( const RArray < TUint > & aFrom,
RArray < TUint > & aTo
) const [private]
Selects all map targets which match the specified source parameters.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

const RArray < TUint > & aFrom The map source parameter set.
RArray < TUint > & aTo The matching target parameters.

SelectTargetSingleL(const RArray< TUint > &, RArray< TUint > &)

void SelectTargetSingleL ( const RArray < TUint > & aFrom,
RArray < TUint > & aTo
) const [private]
Selects the first map target which matches the specified source parameters.
leave
One of the system wide error codes, if a general processing error occurs.

Parameters

const RArray < TUint > & aFrom The map source parameter set.
RArray < TUint > & aTo The matching target parameters.

SubType()

TUint SubType ( ) const

Provides the map subtype code.

Member Data Documentation

__FLOG_DECLARATION_MEMBER_MUTABLE

__FLOG_DECLARATION_MEMBER_MUTABLE [private]

FLOGGER debug trace member variable.

TUint iFrom

TUint iFrom [private]

The routing parameter.

TUint iSubType

TUint iSubType [private]

The routing table sub-type code.

RPointerArray< CMap > iToBranches

RPointerArray < CMap > iToBranches [private]

The CMap branch object container. This container is only populated if implementing an intermediate level (1 .. n-1) of a multi-parameter table.

RArray< TMap > iToNodes

RArray < TMap > iToNodes [private]

The TMap node object container. This container is only populated if implementing a single parameter table or the final level (n) of a multi-parameter table.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.