iso::com::DefaultMessageParser Class Reference

#include <iso_com_default_message_parser.h>

Inherits iso::com::MessageParser.

Inheritance diagram for iso::com::DefaultMessageParser:

Inheritance graph
[legend]
Collaboration diagram for iso::com::DefaultMessageParser:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DefaultMessageParser ()
 default contructor
 ~DefaultMessageParser ()
 destructor
unsigned int messageBufferSize (const Message &pMessage) const throw (ComException)
 calculate message buffer size
bool checkMessage (const Message &pMessage) const
 check if message conforms to expected message format
void message2buffer (const Message &pMessage, ByteBuffer &pMessageBuffer) const throw (ComException)
 convert message into message buffer
void buffer2message (const ByteBuffer &pMessageBuffer, Message &pMessage) const throw (ComException)
 convert message buffer into message
void buffer2packets (const ByteBuffer &pMessageBuffer, QVector< ByteBuffer * > &pPackets, unsigned int pMaxPacketSize) const throw (ComException)
 convert message buffer into data packets
bool match (ByteBuffer &pPacketBuffer, PendingByteBuffer &pMessageBuffer) const throw (ComException)
 check if packet buffer contains data for message buffer
virtual void packet2buffer (const ByteBuffer &pPacketBuffer, PendingByteBuffer &pMessageBuffer) const throw (ComException)
 convert data packet into message buffer
base::String messageInfo (const Message &pMessage) const throw (ComException)
 retrieve textual information about message
base::String packetInfo (const ByteBuffer &pPacketBuffer) const throw (ComException)
 retrieve textual information about data packet

Protected Attributes

QHash< const std::type_info *,
char > 
mValueTypeMap
 size of data packet header information

Static Protected Attributes

static int sMessageHeaderSize
static int sPacketHeaderSize
 size of message header information

Constructor & Destructor Documentation

iso::com::DefaultMessageParser::DefaultMessageParser (  ) 

default contructor

iso::com::DefaultMessageParser::~DefaultMessageParser (  ) 

destructor


Member Function Documentation

unsigned int iso::com::DefaultMessageParser::messageBufferSize ( const Message pMessage  )  const throw (ComException) [virtual]

calculate message buffer size

Parameters:
pMessage message
Returns:
message buffer size (number of bytes)
Exceptions:
ComException message doesn't conform to expected message format

Implements iso::com::MessageParser.

bool iso::com::DefaultMessageParser::checkMessage ( const Message pMessage  )  const [virtual]

check if message conforms to expected message format

Parameters:
pMessage message
Returns:
true if message format is correct, false otherwise

Implements iso::com::MessageParser.

void iso::com::DefaultMessageParser::message2buffer ( const Message pMessage,
ByteBuffer pMessageBuffer 
) const throw (ComException) [virtual]

convert message into message buffer

Parameters:
pMessage message
pMessageBuffer message buffer
Exceptions:
ComException message doesn't conform to expected message format
Remarks:
message buffer array must have been correctly allocated beforehand

Implements iso::com::MessageParser.

void iso::com::DefaultMessageParser::buffer2message ( const ByteBuffer pMessageBuffer,
Message pMessage 
) const throw (ComException) [virtual]

convert message buffer into message

Parameters:
pMessageBuffer message buffer
pMessage message
Exceptions:
ComException message doesn't conform to expected message format

Implements iso::com::MessageParser.

void iso::com::DefaultMessageParser::buffer2packets ( const ByteBuffer pMessageBuffer,
QVector< ByteBuffer * > &  pPackets,
unsigned int  pMaxPacketSize 
) const throw (ComException) [virtual]

convert message buffer into data packets

Parameters:
pMessageBufferPos position of packet within message buffer
pPacketBuffer message buffer
pPackets vector of data packets
pMaxPacketSize maximum packet size (in bytes)

Implements iso::com::MessageParser.

bool iso::com::DefaultMessageParser::match ( ByteBuffer pPacketBuffer,
PendingByteBuffer pMessageBuffer 
) const throw (ComException) [virtual]

check if packet buffer contains data for message buffer

Returns:
true if yes, false otherwise

Implements iso::com::MessageParser.

void iso::com::DefaultMessageParser::packet2buffer ( const ByteBuffer pPacketBuffer,
PendingByteBuffer pMessageBuffer 
) const throw (ComException) [virtual]

convert data packet into message buffer

Parameters:
pPacketBuffer data packet
pMessageBuffer message buffer

Implements iso::com::MessageParser.

base::String iso::com::DefaultMessageParser::messageInfo ( const Message pMessage  )  const throw (ComException) [virtual]

retrieve textual information about message

Parameters:
pMessage message
Returns:
string containing textual message information
Exceptions:
ComException message doesn't conform to expected message format

Implements iso::com::MessageParser.

base::String iso::com::DefaultMessageParser::packetInfo ( const ByteBuffer pPacketBuffer  )  const throw (ComException) [virtual]

retrieve textual information about data packet

Parameters:
pPacketBuffer data packet buffer

Implements iso::com::MessageParser.


Member Data Documentation

int iso::com::DefaultMessageParser::sMessageHeaderSize [static, protected]

int iso::com::DefaultMessageParser::sPacketHeaderSize [static, protected]

size of message header information

QHash< const std::type_info*, char > iso::com::DefaultMessageParser::mValueTypeMap [protected]

size of data packet header information


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 13:53:12 2011 for iso_com by  doxygen 1.5.1