Public Member Functions | Private Member Functions | Private Attributes
devices::SopasEventMessage Class Reference

Class that represents a message that was sent by a sensor. (Event message) More...

#include <SopasBase.hpp>

List of all members.

Public Member Functions

std::string getCommandString () const
SopasBase::SopasEncoding getEncodingType () const
SopasBase::SopasMessageType getMessageType () const
BYTEgetPayLoad ()
 contains 's' + command string(2 byte) + content(payload length - 3)
UINT32 getPayLoadLength () const
 contains 's' + command string(2 byte) + content(payload length - 3)
SopasBase::SopasProtocol getProtocolType () const
INT32 getVariableIndex ()
 Returns the index of a variable (answer to read variable by index). In case of error a negative value will be returned.
std::string getVariableName ()
 Returns the name of a variable (answer to read variable by name). In case of error an empty value will be returned.
bool isValid () const
UINT32 size () const
 SopasEventMessage ()
 Default constructor.
 SopasEventMessage (BYTE *buffer, SopasBase::SopasProtocol protocol, UINT32 frameLength)
 Constructor. This class will only store a pointer to the byte buffer. It will not deallocate the memory. Please make sure that the buffer is not deallocated while you are working with this class.
 ~SopasEventMessage ()
 Destructor.

Private Member Functions

void detectEncoding ()
void detectMessageType ()

Private Attributes

BYTEm_buffer
SopasBase::SopasEncoding m_encoding
UINT32 m_frameLength
SopasBase::SopasMessageType m_messageType
SopasBase::SopasProtocol m_protocol

Detailed Description

Class that represents a message that was sent by a sensor. (Event message)

Definition at line 416 of file SopasBase.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 2158 of file SopasBase.cpp.

Destructor.

Definition at line 423 of file SopasBase.hpp.

Constructor. This class will only store a pointer to the byte buffer. It will not deallocate the memory. Please make sure that the buffer is not deallocated while you are working with this class.

Parameters:
bufferbyte buffer with the message (Sopas frame)
protocoltype of protocol (Cola-A, Cola-B)
frameLengthlength of the frame

Definition at line 2165 of file SopasBase.cpp.


Member Function Documentation

Definition at line 2301 of file SopasBase.cpp.

Definition at line 2313 of file SopasBase.cpp.

Definition at line 2192 of file SopasBase.cpp.

Definition at line 439 of file SopasBase.hpp.

Definition at line 444 of file SopasBase.hpp.

contains 's' + command string(2 byte) + content(payload length - 3)

Definition at line 2214 of file SopasBase.cpp.

contains 's' + command string(2 byte) + content(payload length - 3)

Definition at line 2174 of file SopasBase.cpp.

Definition at line 434 of file SopasBase.hpp.

Returns the index of a variable (answer to read variable by index). In case of error a negative value will be returned.

Definition at line 2233 of file SopasBase.cpp.

Returns the name of a variable (answer to read variable by name). In case of error an empty value will be returned.

Definition at line 2263 of file SopasBase.cpp.

bool devices::SopasEventMessage::isValid ( ) const [inline]

Definition at line 468 of file SopasBase.hpp.

Definition at line 449 of file SopasBase.hpp.


Member Data Documentation

Definition at line 476 of file SopasBase.hpp.

Definition at line 479 of file SopasBase.hpp.

Definition at line 478 of file SopasBase.hpp.

Definition at line 480 of file SopasBase.hpp.

Definition at line 477 of file SopasBase.hpp.


The documentation for this class was generated from the following files:


libsick_ldmrs
Author(s): SICK AG , Martin G√ľnther , Jochen Sprickerhof
autogenerated on Wed Jun 14 2017 04:04:51