CNssTagMgr Class Reference

class CNssTagMgr : public CActive
CNssTagMgr implements the MNssTagMgr interface for tag management services. NssVASApi.lib
Since
2.8

Inherits from

Public Member Functions
~CNssTagMgr ()
void CNssTagListToMNssTagListConvertorL ( CArrayPtrFlat < CNssTag > *)
void CNssTagRefListToMNssTagRefListConvertorL ( CArrayPtrFlat < CNssTagReference > *)
void CancelGetTag ()
MNssTag * CreateTagL ( MNssContext *)
TInt DeleteTag ( MNssDeleteTagClient *, MNssTag *)
void DoCancel ()
CNssTag * GetTag ( TUint32 , TUint32 )
TInt GetTag ( MNssGetTagClient *, MNssTagReference *)
TInt GetTagList ( MNssGetTagClient *, MNssContext *)
TInt GetTagList ( MNssGetTagClient *, MNssContext *, const TDesC &)
TInt GetTagList ( MNssGetTagClient *, MNssContext *, TInt , TInt )
TInt GetTagList ( MNssGetTagClient *, MNssContext *, TDesC &, TInt )
TInt GetTagReferenceList ( MNssGetTagReferenceClient *, MNssContext *)
MNssTagListArray * GetTags ( TNssGrammarIdRuleIdListArray &)
void HandleDeleteSrsDBCompleted ()
void HandleResetSrsDBCompleted ()
void HandleSaveSrsDBCompleted ()
void HandleSrsDBError ( MNssCoreSrsDBEventHandler::TNssSrsDBResult )
CNssTagMgr * NewL ( CNssVASDatabase *, CNssContextMgr *)
CNssTagMgr * NewLC ( CNssVASDatabase *, CNssContextMgr *)
TInt RunError ( TInt )
void RunL ()
TInt SaveTag ( MNssSaveTagClient *, MNssTag *)
TInt TagCount ( MNssContext *)
void VASDatabaseComplete ( CArrayPtrFlat < CNssContext > *, CArrayPtrFlat < CNssTag > *, CArrayPtrFlat < CNssTagReference > *, MNssVASDatabaseClient::TNssVASDBClientReturnCode )
Private Member Functions
CNssTagMgr ()
CNssTagMgr ( CNssVASDatabase *, CNssContextMgr *)
void ConstructL ()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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 Member Enumerations
enum TCallBackState {
ENone , EGetTagClient , EDeleteTagClient , ESaveTagClient , EInterCompTagMgrClient , EGetTagReferenceClient
}
Inherited Enumerations
CActive:TPriority
Private Attributes
CNssContextMgr * iContextManager
MNssDeleteTagClient * iDeleteTagClient
MNssGetTagClient * iGetTagClient
MNssGetTagReferenceClient * iGetTagReferenceClient
MNssInterCompTagMgrClient * iInterCompTagMgrClient
CNssSpeechItem * iLocalSpeechItem
CNssTag * iLocalTag
TBool iRecovery
MNssSaveTagClient * iSaveTagClient
CNssSpeechItemBuilder * iSpeechItemBuilder
TCallBackState iState
CArrayPtrFlat < MNssTag > * iTagList
CArrayPtrFlat < MNssTagReference > * iTagRefList
CNssVASDatabase * iVasDatabase
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CNssTagMgr()

CNssTagMgr ( ) [private]

C++ constructor

CNssTagMgr(CNssVASDatabase *, CNssContextMgr *)

CNssTagMgr ( CNssVASDatabase * aVasDatabase,
CNssContextMgr * aContextManager
) [private]

C++ constructor

Parameters

CNssVASDatabase * aVasDatabase - pointer to the VAS Database
CNssContextMgr * aContextManager - pointer to the context manager

~CNssTagMgr()

~CNssTagMgr ( )

destructor

Member Functions Documentation

CNssTagListToMNssTagListConvertorL(CArrayPtrFlat< CNssTag > *)

void CNssTagListToMNssTagListConvertorL ( CArrayPtrFlat < CNssTag > * aSourceList )
utility function for CNssTag List to MNssTag List conversion, and call back to client
Since
2.0

Parameters

CArrayPtrFlat < CNssTag > * aSourceList - CNssTag List

CNssTagRefListToMNssTagRefListConvertorL(CArrayPtrFlat< CNssTagReference > *)

void CNssTagRefListToMNssTagRefListConvertorL ( CArrayPtrFlat < CNssTagReference > * aSourceList )

Parameters

CArrayPtrFlat < CNssTagReference > * aSourceList

CancelGetTag()

void CancelGetTag ( )
Cancel get tag, for use by inter component clients only, not provided for external clients.
Since
2.0

ConstructL()

void ConstructL ( ) [private]

EPOC constructor

CreateTagL(MNssContext *)

MNssTag * CreateTagL ( MNssContext * aContext )
Creates a new tag
Since
2.0

Parameters

MNssContext * aContext - pointer to context

DeleteTag(MNssDeleteTagClient *, MNssTag *)

TInt DeleteTag ( MNssDeleteTagClient * aTagClient,
MNssTag * aTag
)
delete tag, implementation of interface MNssTagMgr
Since
2.0

Parameters

MNssDeleteTagClient * aTagClient - call back address
MNssTag * aTag - tag to delete

DoCancel()

void DoCancel ( ) [virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel() .

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel() .

CActive::Cancel

GetTag(TUint32, TUint32)

CNssTag * GetTag ( TUint32 aGrammarId,
TUint32 aRuleId
)
get a tag based on grammar id and rule id. for use by VAS components, call back returns a list with one element.
Since
2.0

Parameters

TUint32 aGrammarId - grammar id
TUint32 aRuleId - rule id

GetTag(MNssGetTagClient *, MNssTagReference *)

TInt GetTag ( MNssGetTagClient * aTagClient,
MNssTagReference * aTagReference
)
Get a tag based on tagreference.
Since
2.0

Parameters

MNssGetTagClient * aTagClient - call back address
MNssTagReference * aTagReference - a tagreferenc

GetTagList(MNssGetTagClient *, MNssContext *)

TInt GetTagList ( MNssGetTagClient * aTagClient,
MNssContext * aContext
)
gets tag list, implementation of interface MNssTagMgr
Since
2.0

Parameters

MNssGetTagClient * aTagClient - call back address
MNssContext * aContext - context for which to get tags

GetTagList(MNssGetTagClient *, MNssContext *, const TDesC &)

TInt GetTagList ( MNssGetTagClient * aTagClient,
MNssContext * aContext,
const TDesC & aName
)
gets tag list, implementation of interface MNssTagMgr
Since
2.0

Parameters

MNssGetTagClient * aTagClient - call back address
MNssContext * aContext
const TDesC & aName - name for which to get tags

GetTagList(MNssGetTagClient *, MNssContext *, TInt, TInt)

TInt GetTagList ( MNssGetTagClient * aTagClient,
MNssContext * aContext,
TInt aNum,
TInt aPosition
)
get the tag(s) based on partial rrd int data and position
Since
2.0

Parameters

MNssGetTagClient * aTagClient
MNssContext * aContext
TInt aNum
TInt aPosition - the position of the int value in rrd int array

GetTagList(MNssGetTagClient *, MNssContext *, TDesC &, TInt)

TInt GetTagList ( MNssGetTagClient * aTagClient,
MNssContext * aContext,
TDesC & aText,
TInt aPosition
)
get the tag(s) based on partial rrd text data and position
Since
2.0

Parameters

MNssGetTagClient * aTagClient
MNssContext * aContext
TDesC & aText
TInt aPosition - the position of the int value in rrd int array

GetTagReferenceList(MNssGetTagReferenceClient *, MNssContext *)

TInt GetTagReferenceList ( MNssGetTagReferenceClient * aTagRefClient,
MNssContext * aContext
)
Get a list of tag references based on context.
Since
2.0

Parameters

MNssGetTagReferenceClient * aTagRefClient
MNssContext * aContext - a context

GetTags(TNssGrammarIdRuleIdListArray &)

MNssTagListArray * GetTags ( TNssGrammarIdRuleIdListArray & aGrammarIdRuleIds )

get tags based on their grammar id and rule id. for use by VAS components, call back returns a list with one element.

Parameters

TNssGrammarIdRuleIdListArray & aGrammarIdRuleIds array of grammarid-ruleid pairs return array list. It is to be destroyed by the client

HandleDeleteSrsDBCompleted()

void HandleDeleteSrsDBCompleted ( )
call back implementation from MNssCoreSrsDBEventHandler
Since
2.0

HandleResetSrsDBCompleted()

void HandleResetSrsDBCompleted ( )
Call back function from SRS DB, through interface MNssCoreSrsDBEventHandler Called after deleting from SRS DB is successful
Since
2.8

HandleSaveSrsDBCompleted()

void HandleSaveSrsDBCompleted ( )
call back implementation from MNssCoreSrsDBEventHandler
Since
2.0

HandleSrsDBError(MNssCoreSrsDBEventHandler::TNssSrsDBResult)

void HandleSrsDBError ( MNssCoreSrsDBEventHandler::TNssSrsDBResult aResult )
call back implementation from MNssCoreSrsDBEventHandler
Since
2.0

NewL(CNssVASDatabase *, CNssContextMgr *)

CNssTagMgr * NewL ( CNssVASDatabase * aVasDatabase,
CNssContextMgr * aContextManager
) [static]

2 phase constructor

Parameters

CNssVASDatabase * aVasDatabase - pointer to the VAS Database
CNssContextMgr * aContextManager - pointer to the context manager

NewLC(CNssVASDatabase *, CNssContextMgr *)

CNssTagMgr * NewLC ( CNssVASDatabase * aVasDatabase,
CNssContextMgr * aContextManager
) [static]

2 phase constructor

Parameters

CNssVASDatabase * aVasDatabase - pointer to the VAS Database
CNssContextMgr * aContextManager - pointer to the context manager

RunError(TInt)

TInt RunError ( TInt aError ) [virtual]

Parameters

TInt aError

RunL()

void RunL ( ) [virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD

SaveTag(MNssSaveTagClient *, MNssTag *)

TInt SaveTag ( MNssSaveTagClient * aTagClient,
MNssTag * aTag
)
save tag, implementation of interface MNssTagMgr
Since
2.0

Parameters

MNssSaveTagClient * aTagClient - call back address
MNssTag * aTag - tag to save

TagCount(MNssContext *)

TInt TagCount ( MNssContext * aContext )
gets a tagCount, implementation of interface MNssTagMgr
Since
2.0

Parameters

MNssContext * aContext - context for which to get tag count.

VASDatabaseComplete(CArrayPtrFlat< CNssContext > *, CArrayPtrFlat< CNssTag > *, CArrayPtrFlat< CNssTagReference > *, MNssVASDatabaseClient::TNssVASDBClientReturnCode)

void VASDatabaseComplete ( CArrayPtrFlat < CNssContext > * aContextList,
CArrayPtrFlat < CNssTag > * aTagList,
CArrayPtrFlat < CNssTagReference > * aTagRefList,
MNssVASDatabaseClient::TNssVASDBClientReturnCode aCode
)
call back implementation from MNssVASDatabaseClient
Since
2.0

Parameters

CArrayPtrFlat < CNssContext > * aContextList - list of contexts (not used in tag manager)
CArrayPtrFlat < CNssTag > * aTagList - list of tags
CArrayPtrFlat < CNssTagReference > * aTagRefList
MNssVASDatabaseClient::TNssVASDBClientReturnCode aCode - error code if failed

Member Enumerations Documentation

Enum TCallBackState

Enumerators

ENone
EGetTagClient
EDeleteTagClient
ESaveTagClient
EInterCompTagMgrClient
EGetTagReferenceClient

Member Data Documentation

CNssContextMgr * iContextManager

CNssContextMgr * iContextManager [private]

MNssDeleteTagClient * iDeleteTagClient

MNssDeleteTagClient * iDeleteTagClient [private]

MNssGetTagClient * iGetTagClient

MNssGetTagClient * iGetTagClient [private]

MNssGetTagReferenceClient * iGetTagReferenceClient

MNssGetTagReferenceClient * iGetTagReferenceClient [private]

MNssInterCompTagMgrClient * iInterCompTagMgrClient

MNssInterCompTagMgrClient * iInterCompTagMgrClient [private]

CNssSpeechItem * iLocalSpeechItem

CNssSpeechItem * iLocalSpeechItem [private]

CNssTag * iLocalTag

CNssTag * iLocalTag [private]

TBool iRecovery

TBool iRecovery [private]

MNssSaveTagClient * iSaveTagClient

MNssSaveTagClient * iSaveTagClient [private]

CNssSpeechItemBuilder * iSpeechItemBuilder

CNssSpeechItemBuilder * iSpeechItemBuilder [private]

TCallBackState iState

TCallBackState iState [private]

CArrayPtrFlat< MNssTag > * iTagList

CArrayPtrFlat < MNssTag > * iTagList [private]

CArrayPtrFlat< MNssTagReference > * iTagRefList

CArrayPtrFlat < MNssTagReference > * iTagRefList [private]

CNssVASDatabase * iVasDatabase

CNssVASDatabase * iVasDatabase [private]