Class ConfigData

Defined in File ConfigData.h

Class Documentation

class ConfigData

Config data for current and persistent sensor config.

Public Functions

ConfigData(): The constructor of the config data.

std::string getVersionCVersion() const

Gets the version indicator for the scanner.

Returns: The version indicator for the scanner.

void setVersionCVersion(const std::string &version_c_version)

Sets the version indicator for the scanner.

Parameters: version_c_version – The version indicator for the scanner.

uint8_t getVersionMajorVersionNumber() const

Gets the major version number for the scanner.

Returns: The version indicator for the scanner.

void setVersionMajorVersionNumber(const uint8_t &version_major_version_number)

Sets the major version number for the scanner.

Parameters: version_major_version_number – The major version number for the scanner.

uint8_t getVersionMinorVersionNumber() const

Gets the minor version number for the scanner.

Returns: The minor version number for the scanner.

void setVersionMinorVersionNumber(const uint8_t &version_minor_version_number)

Sets the minor version number for the scanner.

Parameters: version_minor_version_number – The minor version number for the scanner.

uint8_t getVersionReleaseNumber() const

Gets the version release number for the scanner.

Returns: The version release number for the scanner.

void setVersionReleaseNumber(const uint8_t &version_release_number)

Sets the version release number for the scanner.

Parameters: version_release_number – The version release number for the scanner.

boost::asio::ip::address_v4 getHostIp() const

Gets the IP-address of the host.

Returns: The IP-address of the host.

void setHostIp(const boost::asio::ip::address_v4 &host_ip)

Sets the IP-address of the host from an IP-address.

Parameters: host_ip – The new host IP-address.

void setHostIp(const std::string &host_ip)

Sets the IP-address of the host from a string.

Parameters: host_ip – The new host IP-address.

uint16_t getHostUdpPort() const

Gets the host udp port.

Returns: The host udp port.

void setHostUdpPort(const uint16_t &host_udp_port)

Sets the host udp port.

Parameters: host_udp_port – The new host udp port.

uint8_t getChannel() const

Gets the channel of the data.

Returns: The channel of the data.

void setChannel(const uint8_t &channel)

Sets the channel of the data.

Parameters: channel – The new channel.

bool getEnabled() const

Gets if the channel is enabled.

Returns: If the channel is enabled.

void setEnabled(bool enabled)

Sets if the channel is enabled.

Parameters: enabled – If the channel is enabled.

uint8_t getEInterfaceType() const

Gets the eInterface type.

Returns: The eInterface type.

void setEInterfaceType(const uint8_t &e_interface_type)

Sets the eInterface type.

Parameters: e_interface_type – The new eInterface type.

uint16_t getPublishingFrequency() const

Gets the publishing frequency.

Returns: The publishing frequency.

void setPublishingFrequency(const uint16_t &publishing_frequency)

Sets the publishing frequency.

Parameters: publishing_frequency – The publishing frequency.

float getStartAngle() const

Gets the start angle of the scan.

Returns: The start angle of the scan.

void setStartAngle(const int32_t &start_angle)

Sets the start angle of the scan.

Parameters: start_angle – The start angle of the scan.

void setStartAngleDegrees(const float &start_angle)

Set the start angle of the configuration from degrees.

Parameters: start_angle – Start angle of the configuration in degrees.

float getEndAngle() const

Gets the end angle of the scan.

Returns: The end angle of the scan.

void setEndAngle(const int32_t &end_angle)

Sets the end angle of the scan.

Parameters: end_angle – The end angle of the scan.

void setEndAngleDegrees(const float &end_angle)

Set the end angle of the configuration from degrees.

Parameters: end_angle – End angle of the configuration in degrees.

uint16_t getFeatures() const

Gets the enabled features.

Returns: The enabled features.

void setFeatures(const uint16_t &features)

Set the enabled features.

Parameters: features – The new enabled features.

void setFeatures(bool general_system_state, bool derived_settings, bool measurement_data, bool intrusion_data, bool application_data)

Sets the enabled features.

Parameters

general_system_state – If general system state is enabled.
derived_settings – If derived settings are enabled.
measurement_data – If the measurement data is enabled.
intrusion_data – If intrusion data is enabled.
application_data – If application data is enabled.

uint16_t getDerivedMultiplicationFactor() const

Return the multiplication factor. Multiplication factor to be applied to the beam distance values to get the distance in millimeter.

Returns: The multiplication factor.

void setDerivedMultiplicationFactor(const uint16_t &multiplication_factor)

Sets the multiplication factor.

Parameters: multiplication_factor – The new multiplication factor.

uint16_t getDerivedNumberOfBeams() const

Returns the number of beams of the current scan.

Returns: Number of beams.

void setDerivedNumberOfBeams(const uint16_t &number_of_beams)

Sets the number of beams for the current scan.

Parameters: number_of_beams – Number of beams for the scan.

uint16_t getDerivedScanTime() const

Return the time of the scan.

Returns: Time of the scan.

void setDerivedScanTime(const uint16_t &scan_time)

Sets the time of the scan.

Parameters: scan_time – Time of the scan.

float getDerivedStartAngle() const

Get the start angle of the scan.

Returns: Start angle of the scan.

void setDerivedStartAngle(const int32_t &start_angle)

Set the start angle of the scan.

Parameters: start_angle – Start angle of the scan.

float getDerivedAngularBeamResolution() const

Returns the angular resolution between the beams.

Returns: Angular resolution between beams.

void setDerivedAngularBeamResolution(const int32_t &angular_beam_resolution)

Set the angular resolution between beams.

Parameters: angular_beam_resolution – The angular resolution between two beams.

void setDerivedAngularBeamResolutionDegrees(const float &angular_beam_resolution)

Set the angular resolution between beams from degrees.

Parameters: angular_beam_resolution – The angular resolution between two beams in degrees.

uint32_t getDerivedInterbeamPeriod() const

Return the time between consecutive beams.

Returns: Time between consecutive beams.

void setDerivedInterbeamPeriod(const uint32_t &interbeam_period)

Set the time between two consecutive beams.

Parameters: interbeam_period – Time between two consecutive beams.