Class StatusOverview

Class Documentation

class StatusOverview

Class containing the serial number of a laser scanner.

Public Types

enum e_device_state

Values:

enumerator E_NORMAL
enumerator E_ERROR
enumerator E_INITIALIZATION
enumerator E_SHUTDOWN
enumerator E_OPTICS_COVER_CALIBRATION
enum e_config_state

Values:

enumerator E_UNKNOWN
enumerator E_CONFIG_REQUIRED
enumerator E_CONFIG_IN_PROGRESS
enumerator E_NOT_VERIFIED
enumerator E_REJECTED
enumerator E_VERIFIED
enumerator E_INTERNAL_ERROR
enumerator E_VERIFICATION_IN_PROGRESS
enum e_application_state

Values:

enumerator E_STOPPED
enumerator E_STARTING
enumerator E_WAITING_FOR_PARTNERS
enumerator E_WAITING_FOR_INPUTS
enumerator E_STARTED
enumerator E_SLEEP_MODE

Public Functions

StatusOverview()

Constructor of the serial number.

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.

uint8_t getDeviceState() const

Gets the device state for the scanner.

Returns

The device state for the scanner.

void setDeviceState(uint8_t device_state)

Sets the device state for the scanner.

Parameters

device_state – The device state for the scanner.

uint8_t getConfigState() const

Gets the config state for the scanner.

Returns

The config state for the scanner.

void setConfigState(uint8_t config_state)

Sets the config state for the scanner.

Parameters

config_state – The config state for the scanner.

uint8_t getApplicationState() const

Gets the application state for the scanner.

Returns

The application state for the scanner.

void setApplicationState(uint8_t application_state)

Sets the application state for the scanner.

Parameters

application_state – The application state for the scanner.

uint32_t getCurrentTimePowerOnCount() const

Gets the current time power on count for the scanner.

Returns

The current time power on count for the scanner.

void setCurrentTimePowerOnCount(uint32_t current_time_power_on_count)

Sets the current time power on count for the scanner.

Parameters

current_time_power_on_count – The current time power on count for the scanner.

uint32_t getCurrentTimeTime() const

Gets the current time time for the scanner.

Returns

The current time time for the scanner.

void setCurrentTimeTime(uint32_t current_time_time)

Sets the current time time for the scanner.

Parameters

current_time_time – The current time time for the scanner.

uint16_t getCurrentTimeDate() const

Gets the current time date for the scanner.

Returns

The current time date for the scanner.

void setCurrentTimeDate(uint16_t current_time_date)

Sets the current time date for the scanner.

Parameters

current_time_date – The current time date for the scanner.

uint32_t getErrorInfoCode() const

Gets the error info code for the scanner.

Returns

The error info code for the scanner.

void setErrorInfoCode(uint32_t error_info_code)

Sets the error info code for the scanner.

Parameters

error_info_code – The error info code for the scanner.

uint32_t getErrorInfoTime() const

Gets the error info time for the scanner.

Returns

The error info time for the scanner.

void setErrorInfoTime(uint32_t error_info_time)

Sets the error info time for the scanner.

Parameters

error_info_time – The error info time for the scanner.

uint16_t getErrorInfoDate() const

Gets the error info date for the scanner.

Returns

The error info date for the scanner.

void setErrorInfoDate(uint16_t error_info_date)

Sets the error info date for the scanner.

Parameters

error_info_date – The error info date for the scanner.