Class FieldData

Class Documentation

class FieldData

Field data for warning and protective fields.

Public Functions

FieldData()

The constructor of the field data.

bool getIsValid() const

Returns if the received field data is valid.

Returns

If the received field data is valid.

void setIsValid(bool is_valid)

Sets if the field data is valid.

Parameters

is_valid – if the field data is valid.

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.

bool getIsDefined() const

Returns if the received field data is defined.

Returns

If the received field data is defined.

void setIsDefined(bool is_defined)

Sets if the field data is defined.

Parameters

is_defined – if the field data is defined.

uint8_t getEvalMethod() const

Returns the configured eval method.

Returns

The eval method.

void setEvalMethod(const uint8_t &eval_method)

Sets the configured eval method.

Parameters

eval_method – The configured eval method.

uint16_t getMultiSampling() const

Returns the multiple sampling of the field.

Returns

The configured multiple sampling for this field.

void setMultiSampling(const uint16_t &multi_sampling)

Sets the configured multiple sampling of the field.

Parameters

multi_sampling – The configured multiple sampling.

uint16_t getObjectResolution() const

Returns the configured object resolution.

Returns

The configured object resolution.

void setObjectResolution(const uint16_t &object_resolution)

Sets the configured object resolution.

Parameters

object_resolution – The configured object resolution.

uint16_t getFieldSetIndex() const

Returns the index of the field set the field belongs to.

Returns

The index of the field set the field belongs to.

void setFieldSetIndex(const uint16_t &field_set_index)

Sets the index of the field set where the field belongs to.

Parameters

field_set_index – The index of the field set where the field belongs to.

uint32_t getNameLength() const

Gets the length of the field name.

Returns

The length of the field name.

void setNameLength(const uint32_t &name_length)

Sets the length of the field name.

Parameters

name_length – The length of the field name.

std::string getFieldName() const

Gets the current field name.

Returns

The current field name.

void setFieldName(const std::string &field_name)

Sets the field name.

Parameters

field_name – The field name.

bool getIsWarningField() const

Returns if a field is warning field.

Returns

If field is a warning field.

void setIsWarningField(bool is_warning_field)

Set if a field is a warning field.

Parameters

is_warning_field – Set if a field is a warning field.

bool getIsProtectiveField() const

Returns if a field is a protective field.

Returns

If a field is protective.

void setIsProtectiveField(bool is_protective_field)

Set if a field is protective field.

Parameters

is_protective_field – Set if a field is a protective field.

std::vector<uint16_t> getBeamDistances() const

Returns vector with beam distances.

Returns

Vector with beam distances.

void setBeamDistances(const std::vector<uint16_t> &beam_distances)

Sets vector with beam distances for field.

Parameters

beam_distances – New beam distances for field.

float getStartAngle() const

Get the start angle of the scan.

Returns

Start angle of the scan.

void setStartAngle(const int32_t &start_angle)

Set the start angle of the scan.

Parameters

start_angle – Start angle of the scan.

void setStartAngleDegrees(const float &start_angle)

Set the start angle of the scan from degrees.

Parameters

start_angle – Start angle of the scan in degrees.

float getEndAngle() const

Get the end angle of the scan.

Returns

End angle of the scan.

void setEndAngle(const int32_t &end_angle)

Set the end angle of the scan.

Parameters

end_angle – End angle of the scan.

void setEndAngleDegrees(const float &end_angle)

Set the end angle of the scan from degrees.

Parameters

end_angle – End angle of the scan in degrees.

float getAngularBeamResolution() const

Returns the angular resolution between the beams.

Returns

Angular resolution between beams.

void setAngularBeamResolution(const int32_t &angular_beam_resolution)

Set the angular resolution between beams.

Parameters

angular_beam_resolution – The angular resolution between two beams.

void setAngularBeamResolutionDegrees(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.