Class containing the user name of a laser scanner. More...

#include <UserName.h>

Public Member Functions
uint32_t	getNameLength () const
	Gets the length of the user name. More...

std::string	getUserName () const
	Gets the user name 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	setNameLength (const uint32_t &name_length)
	Sets the length of the user name. More...

void	setUserName (const std::string &user_name)
	Sets the user name 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...

	UserName ()
	Constructor of the user name. More...

Private Attributes
uint32_t	m_name_length

std::string	m_user_name

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 user name of a laser scanner.

Definition at line 47 of file UserName.h.

Constructor & Destructor Documentation

sick::datastructure::UserName::UserName ( )

Constructor of the user name.

Definition at line 40 of file UserName.cpp.

Member Function Documentation

uint32_t sick::datastructure::UserName::getNameLength ( ) const

Gets the length of the user name.

Returns: The length of the user name.

Definition at line 82 of file UserName.cpp.

std::string sick::datastructure::UserName::getUserName ( ) const

Gets the user name for the scanner.

Returns: The user name for the scanner.

Definition at line 92 of file UserName.cpp.

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

Gets the version indicator for the scanner.

Returns: The version indicator for the scanner.

Definition at line 42 of file UserName.cpp.

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

Gets the major version number for the scanner.

Returns: The version indicator for the scanner.

Definition at line 52 of file UserName.cpp.

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

Gets the minor version number for the scanner.

Returns: The minor version number for the scanner.

Definition at line 62 of file UserName.cpp.

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

Gets the version release number for the scanner.

Returns: The version release number for the scanner.

Definition at line 72 of file UserName.cpp.

void sick::datastructure::UserName::setNameLength ( const uint32_t & name_length )

Sets the length of the user name.

Parameters

name_length The length of the user name.

Definition at line 87 of file UserName.cpp.

void sick::datastructure::UserName::setUserName ( const std::string & user_name )

Sets the user name for the scanner.

Parameters

user_name The user name for the scanner.

Definition at line 97 of file UserName.cpp.

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

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

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

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

Member Data Documentation

uint32_t sick::datastructure::UserName::m_name_length

private

Definition at line 136 of file UserName.h.

std::string sick::datastructure::UserName::m_user_name

private

Definition at line 137 of file UserName.h.

std::string sick::datastructure::UserName::m_version_c_version

private

Definition at line 132 of file UserName.h.

uint8_t sick::datastructure::UserName::m_version_major_version_number

private

Definition at line 133 of file UserName.h.

uint8_t sick::datastructure::UserName::m_version_minor_version_number

private

Definition at line 134 of file UserName.h.

uint8_t sick::datastructure::UserName::m_version_release_number

private

Definition at line 135 of file UserName.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation