CommsFW::TCFDiscoverMsg Class Reference

class CommsFW::TCFDiscoverMsg : public CommsFW::TCFCommsMessageId

Comms Discovery message. Sent to a CPM to discover which submodules are available for bindings. Can be sent multiple times if the CPM has more submodules than can be contained in one reply.

Nested Classes and Structures

Public Member Functions
TCFDiscoverMsg ( TId , TBool , TUint , TCFSubModuleName *)
TBool Reset ()
TUint Size ()
TCFSubModuleName * SubModuleNames ()
Inherited Functions
CommsFW::TCFCommsMessage::TCFCommsMessage(TCodes)
CommsFW::TCFCommsMessageId::Identifier()const
CommsFW::TCFCommsMessageId::TCFCommsMessageId(TCFCommsMessage::TCodes,TId)
CommsFW::TCFMessage::TCFMessage()
CommsFW::TCFMessage::TCFMessage(TCode,TInt,TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::Code()const
TCFMessageBase< KCFMessageParamBlockSize >::Code(TCode)
TCFMessageBase< KCFMessageParamBlockSize >::IsPIGCode()const
TCFMessageBase< KCFMessageParamBlockSize >::MaxParamBlockSize()
TCFMessageBase< KCFMessageParamBlockSize >::ParamBlock()
TCFMessageBase< KCFMessageParamBlockSize >::ParamBlock()const
TCFMessageBase< KCFMessageParamBlockSize >::ParamBlock(TInt,TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::RawBlock()
TCFMessageBase< KCFMessageParamBlockSize >::RawBlock()const
TCFMessageBase< KCFMessageParamBlockSize >::RawBlock(TInt,const TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::SetPIGCode()
TCFMessageBase< KCFMessageParamBlockSize >::TCFMessageBase()
TCFMessageBase< KCFMessageParamBlockSize >::TCFMessageBase(TCode,TInt,TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::TCFMessageBase(TInt,const TAny *)
Inherited Enumerations
CommsFW::TCFCommsMessage:TCodes
CommsFW::TCFCommsMessageId:@35
TCFMessageBase< KCFMessageParamBlockSize >:@30
TCFMessageBase< KCFMessageParamBlockSize >:@31
Public Member Type Definitions
typedef CommsFW::TCFDiscoverMsg::TParamsTAG TParams

Constructor & Destructor Documentation

TCFDiscoverMsg(TId, TBool, TUint, TCFSubModuleName *)

TCFDiscoverMsg ( TId aIdentifier,
TBool aReset,
TUint aSize,
TCFSubModuleName * aSubModuleNames
) [inline]

Constructor for discovery comms message. TId TCFModuleName

Parameters

TId aIdentifier Unique code identifying the specific message instance.
TBool aReset When ETrue requesting the receiver of the message to start with the first submodulename (like restarting an enumeration). If EFalse start from the first unreported submodulename.
TUint aSize Number of submodulenames that can be written to the iSubModuleNames array.
TCFSubModuleName * aSubModuleNames Array to which a list of names can be written by the receiver, has room for iSize elements.

Member Functions Documentation

Reset()

TBool Reset ( ) const [inline]

Size()

TUint Size ( ) const [inline]

SubModuleNames()

TCFSubModuleName * SubModuleNames ( ) const [inline]

TCFSubModuleName

Member Type Definitions Documentation

Typedef TParams

typedef CommsFW::TCFDiscoverMsg::TParamsTAG TParams

Structure defining the layout of the parameters in the message.