Class DataHeader

Class Documentation

class DataHeader

Contains the content of the data header of a udp data packet.

Public Functions

DataHeader()

Constructor of an empty data header.

uint8_t getVersionIndicator() const

Gets the version indicator. Capital letter ‘V’ or ‘R’ for releases.

Returns

The version indicator.

void setVersionIndicator(const uint8_t &version_indicator)

Sets the version indicator.

Parameters

version_indicator – The new version indicator.

uint8_t getVersionMajorVersion() const

Returns the major version number. Different numbers indicate incompatible implementation.

Returns

The major version indicator.

void setVersionMajorVersion(const uint8_t &version_major_version)

Sets the major version number.

Parameters

version_major_version – The new major version number.

uint8_t getVersionMinorVersion() const

Returns the minor version number. Different numbers indicate compatible implementation if the major version is equal.

Returns

The minor version number.

void setVersionMinorVersion(const uint8_t &version_minor_version)

Sets the minor version number.

Parameters

version_minor_version – The new minor version number.

uint8_t getVersionRelease() const

Gets the release of the version.

Returns

The release of the version.

void setVersionRelease(const uint8_t &version_release)

Sets the release of the version.

Parameters

version_release – The new release of the version.

uint32_t getSerialNumberOfDevice() const

Gets the serial number of the device.

Returns

The serial number of the device.

void setSerialNumberOfDevice(const uint32_t &serial_number_of_device)

Sets the serial number of the device.

Parameters

serial_number_of_device – The serial number of the device.

uint32_t getSerialNumberOfSystemPlug() const

Gets the serial number of the system plug.

Returns

The serial number of the system plug.

void setSerialNumberOfSystemPlug(const uint32_t &serial_number_of_system_plug)

Sets the serial number of the system plug.

Parameters

serial_number_of_system_plug – The serial number of the system plug.

uint8_t getChannelNumber() const

Gets the number of channel the measurement data belongs to.

Returns

The number of channel.

void setChannelNumber(const uint8_t &channel_number)

Sets the number of channel the measurement data belongs to.

Parameters

channel_number – The new channel number.

uint32_t 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.

Returns

The sequence number.

void setSequenceNumber(const uint32_t &sequence_number)

Sets the sequence number of the measurement data.

Parameters

sequence_number – The sequence number.

uint32_t getScanNumber() const

Gets the scan number of the measurement data instance.

Returns

The scan number.

void setScanNumber(const uint32_t &scan_number)

Sets the scan number of the measurement data.

Parameters

scan_number – The new scan number.

uint16_t 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.

Returns

The timestamp date.

void setTimestampDate(const uint16_t &timestamp_date)

Sets the timestamp date.

Parameters

timestamp_date – The new timestamp date.

uint32_t 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.

Returns

The timestamp time.

void setTimestampTime(const uint32_t &timestamp_time)

Sets the timestamp time.

Parameters

timestamp_time – The new timestamp time.

uint16_t 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.

Returns

The general system state block offset.

void setGeneralSystemStateBlockOffset(const uint16_t &general_system_state_block_offset)

Sets the general system state block offset.

Parameters

general_system_state_block_offset – The new general system state block offset.

uint16_t 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.

Returns

The general system state block size.

void setGeneralSystemStateBlockSize(const uint16_t &general_system_state_block_size)

Sets the general system state block size.

Parameters

general_system_state_block_size – The new general system state block size.

uint16_t 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.

Returns

The derived values block offset.

void setDerivedValuesBlockOffset(const uint16_t &derived_values_block_offset)

Sets the derived values block offset.

Parameters

derived_values_block_offset – The new derived values block offset.

uint16_t 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.

Returns

The derived values block size.

void setDerivedValuesBlockSize(const uint16_t &derived_values_block_size)

Sets the derived values block size.

Parameters

derived_values_block_size – The new derived values block size.

uint16_t 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.

Returns

The measurement data block offset.

void setMeasurementDataBlockOffset(const uint16_t &measurement_data_block_offset)

Sets the measurement data block offset.

Parameters

measurement_data_block_offset – The new measurement data block offset.

uint16_t 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.

Returns

The measurement data block size.

void setMeasurementDataBlockSize(const uint16_t &measurement_data_block_size)

Sets the measurement data block size.

Parameters

measurement_data_block_size – The new measurement data block size.

uint16_t 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.

Returns

The intrusion data block offset.

void setIntrusionDataBlockOffset(const uint16_t &intrusion_data_block_offset)

Sets the intrusion data block offset.

Parameters

intrusion_data_block_offset – The new intrusion data block offset.

uint16_t 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.

Returns

The intrusion data block size.

void setIntrusionDataBlockSize(const uint16_t &intrusion_data_block_size)

Sets the intrusion data block size.

Parameters

intrusion_data_block_size – The new intrusion data block size.

uint16_t 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.

Returns

The application io data block offset.

void setApplicationDataBlockOffset(const uint16_t &application_data_block_offset)

Sets the application io data block offset.

Parameters

application_data_block_offset – The new application io data block offset.

uint16_t 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.

Returns

The application data io offset.

void setApplicationDataBlockSize(const uint16_t &application_data_block_size)

Sets the application io data block size.

Parameters

application_data_block_size – The new application data block size.

bool isEmpty() const

Checks if the data header block is empty.

Returns

If the data header is empty.

void setIsEmpty(bool is_empty)

Sets if the data header is empty.

Parameters

is_empty – If the data header is empty.