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 
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:
390 
399  uint32_t m_scan_number;
412 };
413 
414 } // namespace datastructure
415 } // namespace sick
416 
417 #endif // SICK_SAFETYSCANNERS_DATASTRUCTURE_DATAHEADER_H
uint16_t getIntrusionDataBlockOffset() const
Gets the intrusion data block offset.
Definition: DataHeader.cpp:215
uint8_t getVersionMajorVersion() const
Returns the major version number. Different numbers indicate incompatible implementation.
Definition: DataHeader.cpp:55
uint32_t getSerialNumberOfDevice() const
Gets the serial number of the device.
Definition: DataHeader.cpp:85
void setTimestampTime(const uint32_t &timestamp_time)
Sets the timestamp time.
Definition: DataHeader.cpp:150
void setMeasurementDataBlockOffset(const uint16_t &measurement_data_block_offset)
Sets the measurement data block offset.
Definition: DataHeader.cpp:200
void setChannelNumber(const uint8_t &channel_number)
Sets the number of channel the measurement data belongs to.
Definition: DataHeader.cpp:110
bool isEmpty() const
Checks if the data header block is empty.
Definition: DataHeader.cpp:255
uint16_t getApplicationDataBlockOffset() const
Gets the application io data block offset.
Definition: DataHeader.cpp:235
void setApplicationDataBlockSize(const uint16_t &application_data_block_size)
Sets the application io data block size.
Definition: DataHeader.cpp:250
uint16_t getTimestampDate() const
Gets the timestamp date.
Definition: DataHeader.cpp:135
void setSerialNumberOfDevice(const uint32_t &serial_number_of_device)
Sets the serial number of the device.
Definition: DataHeader.cpp:90
uint16_t getIntrusionDataBlockSize() const
Gets the intrusion data block size.
Definition: DataHeader.cpp:225
uint32_t getSerialNumberOfSystemPlug() const
Gets the serial number of the system plug.
Definition: DataHeader.cpp:95
uint16_t getMeasurementDataBlockSize() const
Gets the measurement data block size.
Definition: DataHeader.cpp:205
uint16_t getGeneralSystemStateBlockSize() const
Gets the general system state block size.
Definition: DataHeader.cpp:165
void setGeneralSystemStateBlockOffset(const uint16_t &general_system_state_block_offset)
Sets the general system state block offset.
Definition: DataHeader.cpp:160
void setIntrusionDataBlockSize(const uint16_t &intrusion_data_block_size)
Sets the intrusion data block size.
Definition: DataHeader.cpp:230
uint32_t getTimestampTime() const
Gets the timestamp time.
Definition: DataHeader.cpp:145
uint16_t getApplicationDataBlockSize() const
Gets the application io data block size.
Definition: DataHeader.cpp:245
void setSequenceNumber(const uint32_t &sequence_number)
Sets the sequence number of the measurement data.
Definition: DataHeader.cpp:120
uint16_t getGeneralSystemStateBlockOffset() const
Gets the general system state block offset.
Definition: DataHeader.cpp:155
uint8_t getVersionMinorVersion() const
Returns the minor version number. Different numbers indicate compatible implementation if the major v...
Definition: DataHeader.cpp:65
uint16_t m_general_system_state_block_offset
Definition: DataHeader.h:402
void setDerivedValuesBlockOffset(const uint16_t &derived_values_block_offset)
Sets the derived values block offset.
Definition: DataHeader.cpp:180
void setVersionRelease(const uint8_t &version_release)
Sets the release of the version.
Definition: DataHeader.cpp:80
void setVersionMajorVersion(const uint8_t &version_major_version)
Sets the major version number.
Definition: DataHeader.cpp:60
void setIsEmpty(bool is_empty)
Sets if the data header is empty.
Definition: DataHeader.cpp:260
uint32_t getScanNumber() const
Gets the scan number of the measurement data instance.
Definition: DataHeader.cpp:125
void setDerivedValuesBlockSize(const uint16_t &derived_values_block_size)
Sets the derived values block size.
Definition: DataHeader.cpp:190
void setScanNumber(const uint32_t &scan_number)
Sets the scan number of the measurement data.
Definition: DataHeader.cpp:130
void setSerialNumberOfSystemPlug(const uint32_t &serial_number_of_system_plug)
Sets the serial number of the system plug.
Definition: DataHeader.cpp:100
void setTimestampDate(const uint16_t &timestamp_date)
Sets the timestamp date.
Definition: DataHeader.cpp:140
void setIntrusionDataBlockOffset(const uint16_t &intrusion_data_block_offset)
Sets the intrusion data block offset.
Definition: DataHeader.cpp:220
uint8_t getChannelNumber() const
Gets the number of channel the measurement data belongs to.
Definition: DataHeader.cpp:105
uint16_t getMeasurementDataBlockOffset() const
Gets the measurement data block offset.
Definition: DataHeader.cpp:195
void setGeneralSystemStateBlockSize(const uint16_t &general_system_state_block_size)
Sets the general system state block size.
Definition: DataHeader.cpp:170
uint8_t getVersionIndicator() const
Gets the version indicator. Capital letter &#39;V&#39; or &#39;R&#39; for releases.
Definition: DataHeader.cpp:45
void setVersionIndicator(const uint8_t &version_indicator)
Sets the version indicator.
Definition: DataHeader.cpp:50
uint16_t getDerivedValuesBlockOffset() const
Gets the derived values block offset.
Definition: DataHeader.cpp:175
Contains the content of the data header of a udp data packet.
Definition: DataHeader.h:46
uint16_t getDerivedValuesBlockSize() const
Gets the derived values block size.
Definition: DataHeader.cpp:185
uint32_t getSequenceNumber() const
Gets the sequence number of the measurement data.
Definition: DataHeader.cpp:115
uint8_t getVersionRelease() const
Gets the release of the version.
Definition: DataHeader.cpp:75
DataHeader()
Constructor of an empty data header.
Definition: DataHeader.cpp:40
void setVersionMinorVersion(const uint8_t &version_minor_version)
Sets the minor version number.
Definition: DataHeader.cpp:70
void setMeasurementDataBlockSize(const uint16_t &measurement_data_block_size)
Sets the measurement data block size.
Definition: DataHeader.cpp:210
void setApplicationDataBlockOffset(const uint16_t &application_data_block_offset)
Sets the application io data block offset.
Definition: DataHeader.cpp:240


sick_safetyscanners
Author(s): Lennart Puck
autogenerated on Fri Apr 2 2021 02:45:41