Main Page
Namespaces
Classes
Files
File List
File Members
include
sick_safetyscanners
datastructure
DataHeader.h
Go to the documentation of this file.
1
// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-
2
3
// -- BEGIN LICENSE BLOCK ----------------------------------------------
4
24
// -- END LICENSE BLOCK ------------------------------------------------
25
26
//----------------------------------------------------------------------
33
//----------------------------------------------------------------------
34
35
#ifndef SICK_SAFETYSCANNERS_DATASTRUCTURE_DATAHEADER_H
36
#define SICK_SAFETYSCANNERS_DATASTRUCTURE_DATAHEADER_H
37
38
#include <stdint.h>
39
40
namespace
sick
{
41
namespace
datastructure {
42
46
class
DataHeader
47
{
48
public
:
52
DataHeader
();
53
59
uint8_t
getVersionIndicator
()
const
;
60
66
void
setVersionIndicator
(
const
uint8_t& version_indicator);
67
74
uint8_t
getVersionMajorVersion
()
const
;
75
81
void
setVersionMajorVersion
(
const
uint8_t& version_major_version);
82
89
uint8_t
getVersionMinorVersion
()
const
;
95
void
setVersionMinorVersion
(
const
uint8_t& version_minor_version);
96
102
uint8_t
getVersionRelease
()
const
;
108
void
setVersionRelease
(
const
uint8_t& version_release);
109
115
uint32_t
getSerialNumberOfDevice
()
const
;
121
void
setSerialNumberOfDevice
(
const
uint32_t& serial_number_of_device);
122
128
uint32_t
getSerialNumberOfSystemPlug
()
const
;
134
void
setSerialNumberOfSystemPlug
(
const
uint32_t& serial_number_of_system_plug);
135
141
uint8_t
getChannelNumber
()
const
;
147
void
setChannelNumber
(
const
uint8_t& channel_number);
148
158
uint32_t
getSequenceNumber
()
const
;
164
void
setSequenceNumber
(
const
uint32_t& sequence_number);
165
171
uint32_t
getScanNumber
()
const
;
177
void
setScanNumber
(
const
uint32_t& scan_number);
178
189
uint16_t
getTimestampDate
()
const
;
195
void
setTimestampDate
(
const
uint16_t& timestamp_date);
196
207
uint32_t
getTimestampTime
()
const
;
213
void
setTimestampTime
(
const
uint32_t& timestamp_time);
214
223
uint16_t
getGeneralSystemStateBlockOffset
()
const
;
229
void
setGeneralSystemStateBlockOffset
(
const
uint16_t& general_system_state_block_offset);
230
239
uint16_t
getGeneralSystemStateBlockSize
()
const
;
245
void
setGeneralSystemStateBlockSize
(
const
uint16_t& general_system_state_block_size);
246
255
uint16_t
getDerivedValuesBlockOffset
()
const
;
261
void
setDerivedValuesBlockOffset
(
const
uint16_t& derived_values_block_offset);
262
271
uint16_t
getDerivedValuesBlockSize
()
const
;
277
void
setDerivedValuesBlockSize
(
const
uint16_t& derived_values_block_size);
278
287
uint16_t
getMeasurementDataBlockOffset
()
const
;
293
void
setMeasurementDataBlockOffset
(
const
uint16_t& measurement_data_block_offset);
294
303
uint16_t
getMeasurementDataBlockSize
()
const
;
309
void
setMeasurementDataBlockSize
(
const
uint16_t& measurement_data_block_size);
310
319
uint16_t
getIntrusionDataBlockOffset
()
const
;
325
void
setIntrusionDataBlockOffset
(
const
uint16_t& intrusion_data_block_offset);
326
335
uint16_t
getIntrusionDataBlockSize
()
const
;
341
void
setIntrusionDataBlockSize
(
const
uint16_t& intrusion_data_block_size);
342
351
uint16_t
getApplicationDataBlockOffset
()
const
;
357
void
setApplicationDataBlockOffset
(
const
uint16_t& application_data_block_offset);
358
367
uint16_t
getApplicationDataBlockSize
()
const
;
373
void
setApplicationDataBlockSize
(
const
uint16_t& application_data_block_size);
374
380
bool
isEmpty
()
const
;
386
void
setIsEmpty
(
bool
is_empty);
387
388
private
:
389
bool
m_is_empty
;
390
391
uint8_t
m_version_indicator
;
392
uint8_t
m_version_major_version
;
393
uint8_t
m_version_minor_version
;
394
uint8_t
m_version_release
;
395
uint32_t
m_serial_number_of_device
;
396
uint32_t
m_serial_number_of_system_plug
;
397
uint8_t
m_channel_number
;
398
uint32_t
m_sequence_number
;
399
uint32_t
m_scan_number
;
400
uint16_t
m_timestamp_date
;
401
uint32_t
m_timestamp_time
;
402
uint16_t
m_general_system_state_block_offset
;
403
uint16_t
m_general_system_state_block_size
;
404
uint16_t
m_derived_values_block_offset
;
405
uint16_t
m_derived_values_block_size
;
406
uint16_t
m_measurement_data_block_offset
;
407
uint16_t
m_measurement_data_block_size
;
408
uint16_t
m_intrusion_data_block_offset
;
409
uint16_t
m_intrusion_data_block_size
;
410
uint16_t
m_application_data_block_offset
;
411
uint16_t
m_application_data_block_size
;
412
};
413
414
}
// namespace datastructure
415
}
// namespace sick
416
417
#endif // SICK_SAFETYSCANNERS_DATASTRUCTURE_DATAHEADER_H
sick::datastructure::DataHeader::getIntrusionDataBlockOffset
uint16_t getIntrusionDataBlockOffset() const
Gets the intrusion data block offset.
Definition:
DataHeader.cpp:215
sick::datastructure::DataHeader::getVersionMajorVersion
uint8_t getVersionMajorVersion() const
Returns the major version number. Different numbers indicate incompatible implementation.
Definition:
DataHeader.cpp:55
sick::datastructure::DataHeader::m_timestamp_date
uint16_t m_timestamp_date
Definition:
DataHeader.h:400
sick::datastructure::DataHeader::m_version_major_version
uint8_t m_version_major_version
Definition:
DataHeader.h:392
sick::datastructure::DataHeader::getSerialNumberOfDevice
uint32_t getSerialNumberOfDevice() const
Gets the serial number of the device.
Definition:
DataHeader.cpp:85
sick::datastructure::DataHeader::setTimestampTime
void setTimestampTime(const uint32_t ×tamp_time)
Sets the timestamp time.
Definition:
DataHeader.cpp:150
sick::datastructure::DataHeader::setMeasurementDataBlockOffset
void setMeasurementDataBlockOffset(const uint16_t &measurement_data_block_offset)
Sets the measurement data block offset.
Definition:
DataHeader.cpp:200
sick::datastructure::DataHeader::setChannelNumber
void setChannelNumber(const uint8_t &channel_number)
Sets the number of channel the measurement data belongs to.
Definition:
DataHeader.cpp:110
sick::datastructure::DataHeader::isEmpty
bool isEmpty() const
Checks if the data header block is empty.
Definition:
DataHeader.cpp:255
sick::datastructure::DataHeader::getApplicationDataBlockOffset
uint16_t getApplicationDataBlockOffset() const
Gets the application io data block offset.
Definition:
DataHeader.cpp:235
sick::datastructure::DataHeader::setApplicationDataBlockSize
void setApplicationDataBlockSize(const uint16_t &application_data_block_size)
Sets the application io data block size.
Definition:
DataHeader.cpp:250
sick::datastructure::DataHeader::getTimestampDate
uint16_t getTimestampDate() const
Gets the timestamp date.
Definition:
DataHeader.cpp:135
sick::datastructure::DataHeader::setSerialNumberOfDevice
void setSerialNumberOfDevice(const uint32_t &serial_number_of_device)
Sets the serial number of the device.
Definition:
DataHeader.cpp:90
sick::datastructure::DataHeader::m_serial_number_of_device
uint32_t m_serial_number_of_device
Definition:
DataHeader.h:395
sick::datastructure::DataHeader::getIntrusionDataBlockSize
uint16_t getIntrusionDataBlockSize() const
Gets the intrusion data block size.
Definition:
DataHeader.cpp:225
sick::datastructure::DataHeader::m_channel_number
uint8_t m_channel_number
Definition:
DataHeader.h:397
sick::datastructure::DataHeader::getSerialNumberOfSystemPlug
uint32_t getSerialNumberOfSystemPlug() const
Gets the serial number of the system plug.
Definition:
DataHeader.cpp:95
sick::datastructure::DataHeader::getMeasurementDataBlockSize
uint16_t getMeasurementDataBlockSize() const
Gets the measurement data block size.
Definition:
DataHeader.cpp:205
sick::datastructure::DataHeader::getGeneralSystemStateBlockSize
uint16_t getGeneralSystemStateBlockSize() const
Gets the general system state block size.
Definition:
DataHeader.cpp:165
sick::datastructure::DataHeader::setGeneralSystemStateBlockOffset
void setGeneralSystemStateBlockOffset(const uint16_t &general_system_state_block_offset)
Sets the general system state block offset.
Definition:
DataHeader.cpp:160
sick::datastructure::DataHeader::m_derived_values_block_offset
uint16_t m_derived_values_block_offset
Definition:
DataHeader.h:404
sick::datastructure::DataHeader::setIntrusionDataBlockSize
void setIntrusionDataBlockSize(const uint16_t &intrusion_data_block_size)
Sets the intrusion data block size.
Definition:
DataHeader.cpp:230
sick::datastructure::DataHeader::m_version_minor_version
uint8_t m_version_minor_version
Definition:
DataHeader.h:393
sick::datastructure::DataHeader::getTimestampTime
uint32_t getTimestampTime() const
Gets the timestamp time.
Definition:
DataHeader.cpp:145
sick::datastructure::DataHeader::getApplicationDataBlockSize
uint16_t getApplicationDataBlockSize() const
Gets the application io data block size.
Definition:
DataHeader.cpp:245
sick::datastructure::DataHeader::setSequenceNumber
void setSequenceNumber(const uint32_t &sequence_number)
Sets the sequence number of the measurement data.
Definition:
DataHeader.cpp:120
sick::datastructure::DataHeader::m_general_system_state_block_size
uint16_t m_general_system_state_block_size
Definition:
DataHeader.h:403
sick::datastructure::DataHeader::m_measurement_data_block_size
uint16_t m_measurement_data_block_size
Definition:
DataHeader.h:407
sick::datastructure::DataHeader::getGeneralSystemStateBlockOffset
uint16_t getGeneralSystemStateBlockOffset() const
Gets the general system state block offset.
Definition:
DataHeader.cpp:155
sick::datastructure::DataHeader::m_version_release
uint8_t m_version_release
Definition:
DataHeader.h:394
sick::datastructure::DataHeader::getVersionMinorVersion
uint8_t getVersionMinorVersion() const
Returns the minor version number. Different numbers indicate compatible implementation if the major v...
Definition:
DataHeader.cpp:65
sick::datastructure::DataHeader::m_general_system_state_block_offset
uint16_t m_general_system_state_block_offset
Definition:
DataHeader.h:402
sick::datastructure::DataHeader::setDerivedValuesBlockOffset
void setDerivedValuesBlockOffset(const uint16_t &derived_values_block_offset)
Sets the derived values block offset.
Definition:
DataHeader.cpp:180
sick::datastructure::DataHeader::m_is_empty
bool m_is_empty
Definition:
DataHeader.h:389
sick::datastructure::DataHeader::setVersionRelease
void setVersionRelease(const uint8_t &version_release)
Sets the release of the version.
Definition:
DataHeader.cpp:80
sick::datastructure::DataHeader::setVersionMajorVersion
void setVersionMajorVersion(const uint8_t &version_major_version)
Sets the major version number.
Definition:
DataHeader.cpp:60
sick::datastructure::DataHeader::setIsEmpty
void setIsEmpty(bool is_empty)
Sets if the data header is empty.
Definition:
DataHeader.cpp:260
sick::datastructure::DataHeader::m_timestamp_time
uint32_t m_timestamp_time
Definition:
DataHeader.h:401
sick::datastructure::DataHeader::getScanNumber
uint32_t getScanNumber() const
Gets the scan number of the measurement data instance.
Definition:
DataHeader.cpp:125
sick::datastructure::DataHeader::m_application_data_block_size
uint16_t m_application_data_block_size
Definition:
DataHeader.h:411
sick::datastructure::DataHeader::setDerivedValuesBlockSize
void setDerivedValuesBlockSize(const uint16_t &derived_values_block_size)
Sets the derived values block size.
Definition:
DataHeader.cpp:190
sick::datastructure::DataHeader::setScanNumber
void setScanNumber(const uint32_t &scan_number)
Sets the scan number of the measurement data.
Definition:
DataHeader.cpp:130
sick::datastructure::DataHeader::m_sequence_number
uint32_t m_sequence_number
Definition:
DataHeader.h:398
sick::datastructure::DataHeader::setSerialNumberOfSystemPlug
void setSerialNumberOfSystemPlug(const uint32_t &serial_number_of_system_plug)
Sets the serial number of the system plug.
Definition:
DataHeader.cpp:100
sick
Definition:
ApplicationNameVariableCommand.h:43
sick::datastructure::DataHeader::setTimestampDate
void setTimestampDate(const uint16_t ×tamp_date)
Sets the timestamp date.
Definition:
DataHeader.cpp:140
sick::datastructure::DataHeader::setIntrusionDataBlockOffset
void setIntrusionDataBlockOffset(const uint16_t &intrusion_data_block_offset)
Sets the intrusion data block offset.
Definition:
DataHeader.cpp:220
sick::datastructure::DataHeader::getChannelNumber
uint8_t getChannelNumber() const
Gets the number of channel the measurement data belongs to.
Definition:
DataHeader.cpp:105
sick::datastructure::DataHeader::getMeasurementDataBlockOffset
uint16_t getMeasurementDataBlockOffset() const
Gets the measurement data block offset.
Definition:
DataHeader.cpp:195
sick::datastructure::DataHeader::setGeneralSystemStateBlockSize
void setGeneralSystemStateBlockSize(const uint16_t &general_system_state_block_size)
Sets the general system state block size.
Definition:
DataHeader.cpp:170
sick::datastructure::DataHeader::getVersionIndicator
uint8_t getVersionIndicator() const
Gets the version indicator. Capital letter 'V' or 'R' for releases.
Definition:
DataHeader.cpp:45
sick::datastructure::DataHeader::setVersionIndicator
void setVersionIndicator(const uint8_t &version_indicator)
Sets the version indicator.
Definition:
DataHeader.cpp:50
sick::datastructure::DataHeader::getDerivedValuesBlockOffset
uint16_t getDerivedValuesBlockOffset() const
Gets the derived values block offset.
Definition:
DataHeader.cpp:175
sick::datastructure::DataHeader::m_scan_number
uint32_t m_scan_number
Definition:
DataHeader.h:399
sick::datastructure::DataHeader
Contains the content of the data header of a udp data packet.
Definition:
DataHeader.h:46
sick::datastructure::DataHeader::getDerivedValuesBlockSize
uint16_t getDerivedValuesBlockSize() const
Gets the derived values block size.
Definition:
DataHeader.cpp:185
sick::datastructure::DataHeader::getSequenceNumber
uint32_t getSequenceNumber() const
Gets the sequence number of the measurement data.
Definition:
DataHeader.cpp:115
sick::datastructure::DataHeader::getVersionRelease
uint8_t getVersionRelease() const
Gets the release of the version.
Definition:
DataHeader.cpp:75
sick::datastructure::DataHeader::DataHeader
DataHeader()
Constructor of an empty data header.
Definition:
DataHeader.cpp:40
sick::datastructure::DataHeader::m_intrusion_data_block_size
uint16_t m_intrusion_data_block_size
Definition:
DataHeader.h:409
sick::datastructure::DataHeader::setVersionMinorVersion
void setVersionMinorVersion(const uint8_t &version_minor_version)
Sets the minor version number.
Definition:
DataHeader.cpp:70
sick::datastructure::DataHeader::m_measurement_data_block_offset
uint16_t m_measurement_data_block_offset
Definition:
DataHeader.h:406
sick::datastructure::DataHeader::setMeasurementDataBlockSize
void setMeasurementDataBlockSize(const uint16_t &measurement_data_block_size)
Sets the measurement data block size.
Definition:
DataHeader.cpp:210
sick::datastructure::DataHeader::m_serial_number_of_system_plug
uint32_t m_serial_number_of_system_plug
Definition:
DataHeader.h:396
sick::datastructure::DataHeader::m_intrusion_data_block_offset
uint16_t m_intrusion_data_block_offset
Definition:
DataHeader.h:408
sick::datastructure::DataHeader::m_application_data_block_offset
uint16_t m_application_data_block_offset
Definition:
DataHeader.h:410
sick::datastructure::DataHeader::m_version_indicator
uint8_t m_version_indicator
Definition:
DataHeader.h:391
sick::datastructure::DataHeader::setApplicationDataBlockOffset
void setApplicationDataBlockOffset(const uint16_t &application_data_block_offset)
Sets the application io data block offset.
Definition:
DataHeader.cpp:240
sick::datastructure::DataHeader::m_derived_values_block_size
uint16_t m_derived_values_block_size
Definition:
DataHeader.h:405
sick_safetyscanners
Author(s): Lennart Puck
autogenerated on Fri Apr 2 2021 02:45:41