CommsFW::TCFCommsMessageResult Class Reference

class CommsFW::TCFCommsMessageResult : public CommsFW::TCFCommsMessageId

Base class for Comms messages containing a result code and an identifier.

Nested Classes and Structures

Public Member Functions
TCFCommsMessageResult(TCFCommsMessage::TCodes, TId, TInt)
TInt ReturnCode()
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::TCFCommsMessageResult::TParamsTAG TParams

Constructor & Destructor Documentation

TCFCommsMessageResult(TCFCommsMessage::TCodes, TId, TInt)

TCFCommsMessageResult(TCFCommsMessage::TCodesaCode,
TIdaIdentifier,
TIntaReturnCode
)[inline]

Constructor for comms message type with result TId TCodes

Parameters

TCFCommsMessage::TCodes aCodeCode identifying the specific message type.
TId aIdentifierUnique code identifying the specific message instance.
TInt aReturnCodeCode detailing whether the operation was a success or had some error. Can be one of the system wide error codes or one specific to the module.

Member Functions Documentation

ReturnCode()

TInt ReturnCode()const [inline]

Member Type Definitions Documentation

Typedef TParams

typedef CommsFW::TCFCommsMessageResult::TParamsTAG TParams

Structure defining the layout of the parameters in the message.