Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | Public Member Functions | Public Attributes
MessageLocation Class Reference

Detailed Description

Stores the location of a message in a buffer using a start position and a size.

Definition at line 14 of file messagelocation.h.

#include <xSens_MT4/xcommunication/include/xsens/messagelocation.h>

Public Member Functions

 MessageLocation (int start=-1, int size=0)
 Constructor, initializes by default to an invalid message. More...
 
bool isValid () const
 Returns whether the stored message information describes a valid message. More...
 

Public Attributes

int m_startPos
 The offset of the first byte of the message or -1 if no message. More...
 
int m_size
 The size of the message, when less than 0 it indicates the expected message size. More...
 

Constructor & Destructor Documentation

◆ MessageLocation()

MessageLocation::MessageLocation ( int  start = -1,
int  size = 0 
)
inline

Constructor, initializes by default to an invalid message.

Parameters
startThe offset of the first byte of the message
sizeThe size of the message
See also
isValid()
m_startPos
m_size
IProtocolHandler::findMessage

Definition at line 24 of file messagelocation.h.

Member Function Documentation

◆ isValid()

bool MessageLocation::isValid ( ) const
inline

Returns whether the stored message information describes a valid message.

Definition at line 31 of file messagelocation.h.

References m_size, and m_startPos.

Member Data Documentation

◆ m_size

int MessageLocation::m_size

The size of the message, when less than 0 it indicates the expected message size.

Definition at line 17 of file messagelocation.h.

Referenced by ProtocolHandler::findMessage(), and isValid().

◆ m_startPos

int MessageLocation::m_startPos

The offset of the first byte of the message or -1 if no message.

Definition at line 16 of file messagelocation.h.

Referenced by ProtocolHandler::findMessage(), and isValid().




Page generated by Doxygen 1.8.14 for MRPT 1.5.6 Git: 4c65e8431 Tue Apr 24 08:18:17 2018 +0200 at lun oct 28 01:35:26 CET 2019