Contains the content of the data header of a udp data packet. More...
#include <DataHeader.h>
Public Member Functions | |
DataHeader () | |
Constructor of an empty data header. More... | |
uint16_t | getApplicationDataBlockOffset () const |
Gets the application io data block offset. More... | |
uint16_t | getApplicationDataBlockSize () const |
Gets the application io data block size. More... | |
uint8_t | getChannelNumber () const |
Gets the number of channel the measurement data belongs to. More... | |
uint16_t | getDerivedValuesBlockOffset () const |
Gets the derived values block offset. More... | |
uint16_t | getDerivedValuesBlockSize () const |
Gets the derived values block size. More... | |
uint16_t | getGeneralSystemStateBlockOffset () const |
Gets the general system state block offset. More... | |
uint16_t | getGeneralSystemStateBlockSize () const |
Gets the general system state block size. More... | |
uint16_t | getIntrusionDataBlockOffset () const |
Gets the intrusion data block offset. More... | |
uint16_t | getIntrusionDataBlockSize () const |
Gets the intrusion data block size. More... | |
uint16_t | getMeasurementDataBlockOffset () const |
Gets the measurement data block offset. More... | |
uint16_t | getMeasurementDataBlockSize () const |
Gets the measurement data block size. More... | |
uint32_t | getScanNumber () const |
Gets the scan number of the measurement data instance. More... | |
uint32_t | getSequenceNumber () const |
Gets the sequence number of the measurement data. More... | |
uint32_t | getSerialNumberOfDevice () const |
Gets the serial number of the device. More... | |
uint32_t | getSerialNumberOfSystemPlug () const |
Gets the serial number of the system plug. More... | |
uint16_t | getTimestampDate () const |
Gets the timestamp date. More... | |
uint32_t | getTimestampTime () const |
Gets the timestamp time. More... | |
uint8_t | getVersionIndicator () const |
Gets the version indicator. Capital letter 'V' or 'R' for releases. More... | |
uint8_t | getVersionMajorVersion () const |
Returns the major version number. Different numbers indicate incompatible implementation. More... | |
uint8_t | getVersionMinorVersion () const |
Returns the minor version number. Different numbers indicate compatible implementation if the major version is equal. More... | |
uint8_t | getVersionRelease () const |
Gets the release of the version. More... | |
bool | isEmpty () const |
Checks if the data header block is empty. More... | |
void | setApplicationDataBlockOffset (const uint16_t &application_data_block_offset) |
Sets the application io data block offset. More... | |
void | setApplicationDataBlockSize (const uint16_t &application_data_block_size) |
Sets the application io data block size. More... | |
void | setChannelNumber (const uint8_t &channel_number) |
Sets the number of channel the measurement data belongs to. More... | |
void | setDerivedValuesBlockOffset (const uint16_t &derived_values_block_offset) |
Sets the derived values block offset. More... | |
void | setDerivedValuesBlockSize (const uint16_t &derived_values_block_size) |
Sets the derived values block size. More... | |
void | setGeneralSystemStateBlockOffset (const uint16_t &general_system_state_block_offset) |
Sets the general system state block offset. More... | |
void | setGeneralSystemStateBlockSize (const uint16_t &general_system_state_block_size) |
Sets the general system state block size. More... | |
void | setIntrusionDataBlockOffset (const uint16_t &intrusion_data_block_offset) |
Sets the intrusion data block offset. More... | |
void | setIntrusionDataBlockSize (const uint16_t &intrusion_data_block_size) |
Sets the intrusion data block size. More... | |
void | setIsEmpty (bool is_empty) |
Sets if the data header is empty. More... | |
void | setMeasurementDataBlockOffset (const uint16_t &measurement_data_block_offset) |
Sets the measurement data block offset. More... | |
void | setMeasurementDataBlockSize (const uint16_t &measurement_data_block_size) |
Sets the measurement data block size. More... | |
void | setScanNumber (const uint32_t &scan_number) |
Sets the scan number of the measurement data. More... | |
void | setSequenceNumber (const uint32_t &sequence_number) |
Sets the sequence number of the measurement data. More... | |
void | setSerialNumberOfDevice (const uint32_t &serial_number_of_device) |
Sets the serial number of the device. More... | |
void | setSerialNumberOfSystemPlug (const uint32_t &serial_number_of_system_plug) |
Sets the serial number of the system plug. More... | |
void | setTimestampDate (const uint16_t ×tamp_date) |
Sets the timestamp date. More... | |
void | setTimestampTime (const uint32_t ×tamp_time) |
Sets the timestamp time. More... | |
void | setVersionIndicator (const uint8_t &version_indicator) |
Sets the version indicator. More... | |
void | setVersionMajorVersion (const uint8_t &version_major_version) |
Sets the major version number. More... | |
void | setVersionMinorVersion (const uint8_t &version_minor_version) |
Sets the minor version number. More... | |
void | setVersionRelease (const uint8_t &version_release) |
Sets the release of the version. More... | |
Private Attributes | |
uint16_t | m_application_data_block_offset |
uint16_t | m_application_data_block_size |
uint8_t | m_channel_number |
uint16_t | m_derived_values_block_offset |
uint16_t | m_derived_values_block_size |
uint16_t | m_general_system_state_block_offset |
uint16_t | m_general_system_state_block_size |
uint16_t | m_intrusion_data_block_offset |
uint16_t | m_intrusion_data_block_size |
bool | m_is_empty |
uint16_t | m_measurement_data_block_offset |
uint16_t | m_measurement_data_block_size |
uint32_t | m_scan_number |
uint32_t | m_sequence_number |
uint32_t | m_serial_number_of_device |
uint32_t | m_serial_number_of_system_plug |
uint16_t | m_timestamp_date |
uint32_t | m_timestamp_time |
uint8_t | m_version_indicator |
uint8_t | m_version_major_version |
uint8_t | m_version_minor_version |
uint8_t | m_version_release |
Contains the content of the data header of a udp data packet.
Definition at line 46 of file DataHeader.h.
sick::datastructure::DataHeader::DataHeader | ( | ) |
Constructor of an empty data header.
Definition at line 40 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getApplicationDataBlockOffset | ( | ) | const |
Gets the application io data block offset.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 235 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getApplicationDataBlockSize | ( | ) | const |
Gets the application io data block size.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 245 of file DataHeader.cpp.
uint8_t sick::datastructure::DataHeader::getChannelNumber | ( | ) | const |
Gets the number of channel the measurement data belongs to.
Definition at line 105 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getDerivedValuesBlockOffset | ( | ) | const |
Gets the derived values block offset.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 175 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getDerivedValuesBlockSize | ( | ) | const |
Gets the derived values block size.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 185 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getGeneralSystemStateBlockOffset | ( | ) | const |
Gets the general system state block offset.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 155 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getGeneralSystemStateBlockSize | ( | ) | const |
Gets the general system state block size.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 165 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getIntrusionDataBlockOffset | ( | ) | const |
Gets the intrusion data block offset.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 215 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getIntrusionDataBlockSize | ( | ) | const |
Gets the intrusion data block size.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 225 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getMeasurementDataBlockOffset | ( | ) | const |
Gets the measurement data block offset.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 195 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getMeasurementDataBlockSize | ( | ) | const |
Gets the measurement data block size.
If a block is not included (not configured or data currently not available) then Size = 0 and Offset = 0.
Definition at line 205 of file DataHeader.cpp.
uint32_t sick::datastructure::DataHeader::getScanNumber | ( | ) | const |
Gets the scan number of the measurement data instance.
Definition at line 125 of file DataHeader.cpp.
uint32_t sick::datastructure::DataHeader::getSequenceNumber | ( | ) | const |
Gets the sequence number of the measurement data.
This sequence number increases with each instance of measurement data that is produced by a given channel.
Definition at line 115 of file DataHeader.cpp.
uint32_t sick::datastructure::DataHeader::getSerialNumberOfDevice | ( | ) | const |
Gets the serial number of the device.
Definition at line 85 of file DataHeader.cpp.
uint32_t sick::datastructure::DataHeader::getSerialNumberOfSystemPlug | ( | ) | const |
Gets the serial number of the system plug.
Definition at line 95 of file DataHeader.cpp.
uint16_t sick::datastructure::DataHeader::getTimestampDate | ( | ) | const |
Gets the timestamp date.
A timestamp when the measurement data output instance was created. Note: While the measurements are performed periodically using the configured scan cycle time, you may experience a jitter in the timestamp reported here as it is not synchronized with the start of the scan.
Definition at line 135 of file DataHeader.cpp.
uint32_t sick::datastructure::DataHeader::getTimestampTime | ( | ) | const |
Gets the timestamp time.
A timestamp when the measurement data output instance was created. Note: While the measurements are performed periodically using the configured scan cycle time, you may experience a jitter in the timestamp reported here as it is not synchronized with the start of the scan.
Definition at line 145 of file DataHeader.cpp.
uint8_t sick::datastructure::DataHeader::getVersionIndicator | ( | ) | const |
Gets the version indicator. Capital letter 'V' or 'R' for releases.
Definition at line 45 of file DataHeader.cpp.
uint8_t sick::datastructure::DataHeader::getVersionMajorVersion | ( | ) | const |
Returns the major version number. Different numbers indicate incompatible implementation.
Definition at line 55 of file DataHeader.cpp.
uint8_t sick::datastructure::DataHeader::getVersionMinorVersion | ( | ) | const |
Returns the minor version number. Different numbers indicate compatible implementation if the major version is equal.
Definition at line 65 of file DataHeader.cpp.
uint8_t sick::datastructure::DataHeader::getVersionRelease | ( | ) | const |
Gets the release of the version.
Definition at line 75 of file DataHeader.cpp.
bool sick::datastructure::DataHeader::isEmpty | ( | ) | const |
Checks if the data header block is empty.
Definition at line 255 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setApplicationDataBlockOffset | ( | const uint16_t & | application_data_block_offset | ) |
Sets the application io data block offset.
application_data_block_offset | The new application io data block offset. |
Definition at line 240 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setApplicationDataBlockSize | ( | const uint16_t & | application_data_block_size | ) |
Sets the application io data block size.
application_data_block_size | The new application data block size. |
Definition at line 250 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setChannelNumber | ( | const uint8_t & | channel_number | ) |
Sets the number of channel the measurement data belongs to.
channel_number | The new channel number. |
Definition at line 110 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setDerivedValuesBlockOffset | ( | const uint16_t & | derived_values_block_offset | ) |
Sets the derived values block offset.
derived_values_block_offset | The new derived values block offset. |
Definition at line 180 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setDerivedValuesBlockSize | ( | const uint16_t & | derived_values_block_size | ) |
Sets the derived values block size.
derived_values_block_size | The new derived values block size. |
Definition at line 190 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setGeneralSystemStateBlockOffset | ( | const uint16_t & | general_system_state_block_offset | ) |
Sets the general system state block offset.
general_system_state_block_offset | The new general system state block offset. |
Definition at line 160 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setGeneralSystemStateBlockSize | ( | const uint16_t & | general_system_state_block_size | ) |
Sets the general system state block size.
general_system_state_block_size | The new general system state block size. |
Definition at line 170 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setIntrusionDataBlockOffset | ( | const uint16_t & | intrusion_data_block_offset | ) |
Sets the intrusion data block offset.
intrusion_data_block_offset | The new intrusion data block offset. |
Definition at line 220 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setIntrusionDataBlockSize | ( | const uint16_t & | intrusion_data_block_size | ) |
Sets the intrusion data block size.
intrusion_data_block_size | The new intrusion data block size. |
Definition at line 230 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setIsEmpty | ( | bool | is_empty | ) |
Sets if the data header is empty.
is_empty | If the data header is empty. |
Definition at line 260 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setMeasurementDataBlockOffset | ( | const uint16_t & | measurement_data_block_offset | ) |
Sets the measurement data block offset.
measurement_data_block_offset | The new measurement data block offset. |
Definition at line 200 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setMeasurementDataBlockSize | ( | const uint16_t & | measurement_data_block_size | ) |
Sets the measurement data block size.
measurement_data_block_size | The new measurement data block size. |
Definition at line 210 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setScanNumber | ( | const uint32_t & | scan_number | ) |
Sets the scan number of the measurement data.
scan_number | The new scan number. |
Definition at line 130 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setSequenceNumber | ( | const uint32_t & | sequence_number | ) |
Sets the sequence number of the measurement data.
sequence_number | The sequence number. |
Definition at line 120 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setSerialNumberOfDevice | ( | const uint32_t & | serial_number_of_device | ) |
Sets the serial number of the device.
serial_number_of_device | The serial number of the device. |
Definition at line 90 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setSerialNumberOfSystemPlug | ( | const uint32_t & | serial_number_of_system_plug | ) |
Sets the serial number of the system plug.
serial_number_of_system_plug | The serial number of the system plug. |
Definition at line 100 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setTimestampDate | ( | const uint16_t & | timestamp_date | ) |
Sets the timestamp date.
timestamp_date | The new timestamp date. |
Definition at line 140 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setTimestampTime | ( | const uint32_t & | timestamp_time | ) |
Sets the timestamp time.
timestamp_time | The new timestamp time. |
Definition at line 150 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setVersionIndicator | ( | const uint8_t & | version_indicator | ) |
Sets the version indicator.
version_indicator | The new version indicator. |
Definition at line 50 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setVersionMajorVersion | ( | const uint8_t & | version_major_version | ) |
Sets the major version number.
version_major_version | The new major version number. |
Definition at line 60 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setVersionMinorVersion | ( | const uint8_t & | version_minor_version | ) |
Sets the minor version number.
version_minor_version | The new minor version number. |
Definition at line 70 of file DataHeader.cpp.
void sick::datastructure::DataHeader::setVersionRelease | ( | const uint8_t & | version_release | ) |
Sets the release of the version.
version_release | The new release of the version. |
Definition at line 80 of file DataHeader.cpp.
|
private |
Definition at line 410 of file DataHeader.h.
|
private |
Definition at line 411 of file DataHeader.h.
|
private |
Definition at line 397 of file DataHeader.h.
|
private |
Definition at line 404 of file DataHeader.h.
|
private |
Definition at line 405 of file DataHeader.h.
|
private |
Definition at line 402 of file DataHeader.h.
|
private |
Definition at line 403 of file DataHeader.h.
|
private |
Definition at line 408 of file DataHeader.h.
|
private |
Definition at line 409 of file DataHeader.h.
|
private |
Definition at line 389 of file DataHeader.h.
|
private |
Definition at line 406 of file DataHeader.h.
|
private |
Definition at line 407 of file DataHeader.h.
|
private |
Definition at line 399 of file DataHeader.h.
|
private |
Definition at line 398 of file DataHeader.h.
|
private |
Definition at line 395 of file DataHeader.h.
|
private |
Definition at line 396 of file DataHeader.h.
|
private |
Definition at line 400 of file DataHeader.h.
|
private |
Definition at line 401 of file DataHeader.h.
|
private |
Definition at line 391 of file DataHeader.h.
|
private |
Definition at line 392 of file DataHeader.h.
|
private |
Definition at line 393 of file DataHeader.h.
|
private |
Definition at line 394 of file DataHeader.h.