Class containing the serial number of a laser scanner. More...

#include <StatusOverview.h>

Public Types
enum	e_application_state { E_STOPPED, E_STARTING, E_WAITING_FOR_PARTNERS, E_WAITING_FOR_INPUTS, E_STARTED, E_SLEEP_MODE }

enum	e_config_state { E_UNKNOWN, E_CONFIG_REQUIRED, E_CONFIG_IN_PROGRESS, E_NOT_VERIFIED, E_REJECTED, E_VERIFIED, E_INTERNAL_ERROR, E_VERIFICATION_IN_PROGRESS }

enum	e_device_state { E_NORMAL, E_ERROR, E_INITIALIZATION, E_SHUTDOWN, E_OPTICS_COVER_CALIBRATION }

Public Member Functions
uint8_t	getApplicationState () const
	Gets the application state for the scanner. More...

uint8_t	getConfigState () const
	Gets the config state for the scanner. More...

uint16_t	getCurrentTimeDate () const
	Gets the current time date for the scanner. More...

uint32_t	getCurrentTimePowerOnCount () const
	Gets the current time power on count for the scanner. More...

uint32_t	getCurrentTimeTime () const
	Gets the current time time for the scanner. More...

uint8_t	getDeviceState () const
	Gets the device state for the scanner. More...

uint32_t	getErrorInfoCode () const
	Gets the error info code for the scanner. More...

uint16_t	getErrorInfoDate () const
	Gets the error info date for the scanner. More...

uint32_t	getErrorInfoTime () const
	Gets the error info time for the scanner. More...

std::string	getVersionCVersion () const
	Gets the version indicator for the scanner. More...

uint8_t	getVersionMajorVersionNumber () const
	Gets the major version number for the scanner. More...

uint8_t	getVersionMinorVersionNumber () const
	Gets the minor version number for the scanner. More...

uint8_t	getVersionReleaseNumber () const
	Gets the version release number for the scanner. More...

void	setApplicationState (uint8_t application_state)
	Sets the application state for the scanner. More...

void	setConfigState (uint8_t config_state)
	Sets the config state for the scanner. More...

void	setCurrentTimeDate (uint16_t current_time_date)
	Sets the current time date for the scanner. More...

void	setCurrentTimePowerOnCount (uint32_t current_time_power_on_count)
	Sets the current time power on count for the scanner. More...

void	setCurrentTimeTime (uint32_t current_time_time)
	Sets the current time time for the scanner. More...

void	setDeviceState (uint8_t device_state)
	Sets the device state for the scanner. More...

void	setErrorInfoCode (uint32_t error_info_code)
	Sets the error info code for the scanner. More...

void	setErrorInfoDate (uint16_t error_info_date)
	Sets the error info date for the scanner. More...

void	setErrorInfoTime (uint32_t error_info_time)
	Sets the error info time for the scanner. More...

void	setVersionCVersion (const std::string &version_c_version)
	Sets the version indicator for the scanner. More...

void	setVersionMajorVersionNumber (const uint8_t &version_major_version_number)
	Sets the major version number for the scanner. More...

void	setVersionMinorVersionNumber (const uint8_t &version_minor_version_number)
	Sets the minor version number for the scanner. More...

void	setVersionReleaseNumber (const uint8_t &version_release_number)
	Sets the version release number for the scanner. More...

	StatusOverview ()
	Constructor of the serial number. More...

Private Attributes
uint8_t	m_application_state

uint8_t	m_config_state

uint16_t	m_current_time_date

uint32_t	m_current_time_power_on_count

uint32_t	m_current_time_time

uint8_t	m_device_state

uint32_t	m_error_info_code

uint16_t	m_error_info_date

uint32_t	m_error_info_time

std::string	m_version_c_version

uint8_t	m_version_major_version_number

uint8_t	m_version_minor_version_number

uint8_t	m_version_release_number

Detailed Description

Class containing the serial number of a laser scanner.

Definition at line 47 of file StatusOverview.h.

Member Enumeration Documentation

enum sick::datastructure::StatusOverview::e_application_state

Enumerator
E_STOPPED
E_STARTING
E_WAITING_FOR_PARTNERS
E_WAITING_FOR_INPUTS
E_STARTED
E_SLEEP_MODE

Definition at line 71 of file StatusOverview.h.

enum sick::datastructure::StatusOverview::e_config_state

Enumerator
E_UNKNOWN
E_CONFIG_REQUIRED
E_CONFIG_IN_PROGRESS
E_NOT_VERIFIED
E_REJECTED
E_VERIFIED
E_INTERNAL_ERROR
E_VERIFICATION_IN_PROGRESS

Definition at line 59 of file StatusOverview.h.

enum sick::datastructure::StatusOverview::e_device_state

Enumerator
E_NORMAL
E_ERROR
E_INITIALIZATION
E_SHUTDOWN
E_OPTICS_COVER_CALIBRATION

Definition at line 50 of file StatusOverview.h.

Constructor & Destructor Documentation

sick::datastructure::StatusOverview::StatusOverview ( )

Constructor of the serial number.

Definition at line 40 of file StatusOverview.cpp.

Member Function Documentation

uint8_t sick::datastructure::StatusOverview::getApplicationState ( ) const

Gets the application state for the scanner.

Returns: The application state for the scanner.

Definition at line 102 of file StatusOverview.cpp.

uint8_t sick::datastructure::StatusOverview::getConfigState ( ) const

Gets the config state for the scanner.

Returns: The config state for the scanner.

Definition at line 92 of file StatusOverview.cpp.

uint16_t sick::datastructure::StatusOverview::getCurrentTimeDate ( ) const

Gets the current time date for the scanner.

Returns: The current time date for the scanner.

Definition at line 132 of file StatusOverview.cpp.

uint32_t sick::datastructure::StatusOverview::getCurrentTimePowerOnCount ( ) const

Gets the current time power on count for the scanner.

Returns: The current time power on count for the scanner.

Definition at line 112 of file StatusOverview.cpp.

uint32_t sick::datastructure::StatusOverview::getCurrentTimeTime ( ) const

Gets the current time time for the scanner.

Returns: The current time time for the scanner.

Definition at line 122 of file StatusOverview.cpp.

uint8_t sick::datastructure::StatusOverview::getDeviceState ( ) const

Gets the device state for the scanner.

Returns: The device state for the scanner.

Definition at line 82 of file StatusOverview.cpp.

uint32_t sick::datastructure::StatusOverview::getErrorInfoCode ( ) const

Gets the error info code for the scanner.

Returns: The error info code for the scanner.

Definition at line 142 of file StatusOverview.cpp.

uint16_t sick::datastructure::StatusOverview::getErrorInfoDate ( ) const

Gets the error info date for the scanner.

Returns: The error info date for the scanner.

Definition at line 162 of file StatusOverview.cpp.

uint32_t sick::datastructure::StatusOverview::getErrorInfoTime ( ) const

Gets the error info time for the scanner.

Returns: The error info time for the scanner.

Definition at line 152 of file StatusOverview.cpp.

std::string sick::datastructure::StatusOverview::getVersionCVersion ( ) const

Gets the version indicator for the scanner.

Returns: The version indicator for the scanner.

Definition at line 42 of file StatusOverview.cpp.

uint8_t sick::datastructure::StatusOverview::getVersionMajorVersionNumber ( ) const

Gets the major version number for the scanner.

Returns: The version indicator for the scanner.

Definition at line 52 of file StatusOverview.cpp.

uint8_t sick::datastructure::StatusOverview::getVersionMinorVersionNumber ( ) const

Gets the minor version number for the scanner.

Returns: The minor version number for the scanner.

Definition at line 62 of file StatusOverview.cpp.

uint8_t sick::datastructure::StatusOverview::getVersionReleaseNumber ( ) const

Gets the version release number for the scanner.

Returns: The version release number for the scanner.

Definition at line 72 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::setApplicationState ( uint8_t application_state )

Sets the application state for the scanner.

Parameters

application_state The application state for the scanner.

Definition at line 107 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::setConfigState ( uint8_t config_state )

Sets the config state for the scanner.

Parameters

config_state The config state for the scanner.

Definition at line 97 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 137 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 117 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 127 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::setDeviceState ( uint8_t device_state )

Sets the device state for the scanner.

Parameters

device_state The device state for the scanner.

Definition at line 87 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 147 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 167 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 157 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::setVersionCVersion ( const std::string & version_c_version )

Sets the version indicator for the scanner.

Parameters

version_c_version The version indicator for the scanner.

Definition at line 47 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 57 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 67 of file StatusOverview.cpp.

void sick::datastructure::StatusOverview::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.

Definition at line 77 of file StatusOverview.cpp.

Member Data Documentation

uint8_t sick::datastructure::StatusOverview::m_application_state

private

Definition at line 264 of file StatusOverview.h.

uint8_t sick::datastructure::StatusOverview::m_config_state

private

Definition at line 263 of file StatusOverview.h.

uint16_t sick::datastructure::StatusOverview::m_current_time_date

private

Definition at line 267 of file StatusOverview.h.

uint32_t sick::datastructure::StatusOverview::m_current_time_power_on_count

private

Definition at line 265 of file StatusOverview.h.

uint32_t sick::datastructure::StatusOverview::m_current_time_time

private

Definition at line 266 of file StatusOverview.h.

uint8_t sick::datastructure::StatusOverview::m_device_state

private

Definition at line 262 of file StatusOverview.h.

uint32_t sick::datastructure::StatusOverview::m_error_info_code

private

Definition at line 268 of file StatusOverview.h.

uint16_t sick::datastructure::StatusOverview::m_error_info_date

private

Definition at line 270 of file StatusOverview.h.

uint32_t sick::datastructure::StatusOverview::m_error_info_time

private

Definition at line 269 of file StatusOverview.h.

std::string sick::datastructure::StatusOverview::m_version_c_version

private

Definition at line 258 of file StatusOverview.h.

uint8_t sick::datastructure::StatusOverview::m_version_major_version_number

private

Definition at line 259 of file StatusOverview.h.

uint8_t sick::datastructure::StatusOverview::m_version_minor_version_number

private

Definition at line 260 of file StatusOverview.h.

uint8_t sick::datastructure::StatusOverview::m_version_release_number

private

Definition at line 261 of file StatusOverview.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation