Class that represents a message that was sent by a sensor. (Event message) More...
#include <SopasBase.hpp>
Public Member Functions | |
| std::string | getCommandString () const |
| SopasBase::SopasEncoding | getEncodingType () const |
| SopasBase::SopasMessageType | getMessageType () const |
| BYTE * | getPayLoad () |
| 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 | |
| BYTE * | m_buffer |
| SopasBase::SopasEncoding | m_encoding |
| UINT32 | m_frameLength |
| SopasBase::SopasMessageType | m_messageType |
| SopasBase::SopasProtocol | m_protocol |
Class that represents a message that was sent by a sensor. (Event message)
Definition at line 416 of file SopasBase.hpp.
Default constructor.
Definition at line 2156 of file SopasBase.cpp.
| devices::SopasEventMessage::~SopasEventMessage | ( | ) | [inline] |
Destructor.
Definition at line 423 of file SopasBase.hpp.
| SopasEventMessage::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.
| buffer | byte buffer with the message (Sopas frame) |
| protocol | type of protocol (Cola-A, Cola-B) |
| frameLength | length of the frame |
Definition at line 2163 of file SopasBase.cpp.
| void SopasEventMessage::detectEncoding | ( | ) | [private] |
Definition at line 2299 of file SopasBase.cpp.
| void SopasEventMessage::detectMessageType | ( | ) | [private] |
Definition at line 2311 of file SopasBase.cpp.
| std::string SopasEventMessage::getCommandString | ( | ) | const |
Definition at line 2190 of file SopasBase.cpp.
| SopasBase::SopasEncoding devices::SopasEventMessage::getEncodingType | ( | ) | const [inline] |
Definition at line 439 of file SopasBase.hpp.
| SopasBase::SopasMessageType devices::SopasEventMessage::getMessageType | ( | ) | const [inline] |
Definition at line 444 of file SopasBase.hpp.
contains 's' + command string(2 byte) + content(payload length - 3)
Definition at line 2212 of file SopasBase.cpp.
| UINT32 SopasEventMessage::getPayLoadLength | ( | ) | const |
contains 's' + command string(2 byte) + content(payload length - 3)
Definition at line 2172 of file SopasBase.cpp.
| SopasBase::SopasProtocol devices::SopasEventMessage::getProtocolType | ( | void | ) | const [inline] |
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 2231 of file SopasBase.cpp.
| std::string SopasEventMessage::getVariableName | ( | ) |
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 2261 of file SopasBase.cpp.
| bool devices::SopasEventMessage::isValid | ( | ) | const [inline] |
Definition at line 468 of file SopasBase.hpp.
| UINT32 devices::SopasEventMessage::size | ( | ) | const [inline] |
Definition at line 449 of file SopasBase.hpp.
BYTE* devices::SopasEventMessage::m_buffer [private] |
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.