Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
psen_scan::RosParameterHandler Class Reference

Class for getting ROS-Parameters from the parameter-server. More...

#include <ros_parameter_handler.h>

Public Member Functions

PSENscanInternalAngle getAngleEnd () const
 Getter Method for angle_end_. More...
 
PSENscanInternalAngle getAngleStart () const
 Getter Method for angle_start_. More...
 
std::string getFrameID () const
 Getter method for frame_id_. More...
 
uint32_t getHostIP () const
 Getter method for host_ip_. More...
 
uint32_t getHostUDPPort () const
 Getter method for host_udp_port_. More...
 
template<class T >
bool getOptionalParamFromParamServer (const std::string &key, T &param)
 Gets one optional ROS-parameter from parameter server. More...
 
std::string getPassword () const
 Getter method for password_. More...
 
template<class T >
void getRequiredParamFromParamServer (const std::string &key, T &param)
 Gets one required ROS-parameter from parameter server. More...
 
std::string getSensorIP () const
 Getter Method for sensor_ip_. More...
 
uint16_t getSkip () const
 Getter method for skip_. More...
 
Degree getXAxisRotation () const
 Getter Method for x_axis_rotation_. More...
 
 RosParameterHandler (const ros::NodeHandle &nh)
 Construct a new Ros Parameter Handler:: Ros Parameter Handler object. More...
 
void updateAllParamsFromParamServer ()
 Update all Parameters from ROS Parameter Server. More...
 

Static Public Member Functions

static std::string decryptPassword (const std::string &encrypted_password)
 Decrypt password. More...
 

Private Attributes

PSENscanInternalAngle angle_end_
 
PSENscanInternalAngle angle_start_
 
std::string frame_id_
 
uint32_t host_ip_
 
uint32_t host_udp_port_
 
ros::NodeHandle const nh_
 
std::string password_
 
std::string sensor_ip_
 
uint16_t skip_
 
Degree x_axis_rotation_
 

Detailed Description

Class for getting ROS-Parameters from the parameter-server.

Definition at line 28 of file ros_parameter_handler.h.

Constructor & Destructor Documentation

◆ RosParameterHandler()

psen_scan::RosParameterHandler::RosParameterHandler ( const ros::NodeHandle nh)

Construct a new Ros Parameter Handler:: Ros Parameter Handler object.

Gets all Parameters from Parameter Server.

Parameters
nhNodehandle from which parameters will be fetched
Exceptions
PSENScanFatalException

Definition at line 36 of file ros_parameter_handler.cpp.

Member Function Documentation

◆ decryptPassword()

std::string psen_scan::RosParameterHandler::decryptPassword ( const std::string &  encrypted_password)
static

Decrypt password.

Parameters
encrypted_passwordEncrypted Password
Returns
Decrypted Password
Exceptions
DecryptPasswordException

Definition at line 367 of file ros_parameter_handler.cpp.

◆ getAngleEnd()

PSENscanInternalAngle psen_scan::RosParameterHandler::getAngleEnd ( ) const

Getter Method for angle_end_.

Returns
uint16_t

Definition at line 344 of file ros_parameter_handler.cpp.

◆ getAngleStart()

PSENscanInternalAngle psen_scan::RosParameterHandler::getAngleStart ( ) const

Getter Method for angle_start_.

Returns
uint16_t

Definition at line 334 of file ros_parameter_handler.cpp.

◆ getFrameID()

std::string psen_scan::RosParameterHandler::getFrameID ( ) const

Getter method for frame_id_.

Returns
std::string

Definition at line 314 of file ros_parameter_handler.cpp.

◆ getHostIP()

uint32_t psen_scan::RosParameterHandler::getHostIP ( ) const

Getter method for host_ip_.

Returns
uint32_t

Definition at line 284 of file ros_parameter_handler.cpp.

◆ getHostUDPPort()

uint32_t psen_scan::RosParameterHandler::getHostUDPPort ( ) const

Getter method for host_udp_port_.

Returns
uint32_t

Definition at line 294 of file ros_parameter_handler.cpp.

◆ getOptionalParamFromParamServer()

template<class T >
bool psen_scan::RosParameterHandler::getOptionalParamFromParamServer ( const std::string &  key,
T &  param 
)

Gets one optional ROS-parameter from parameter server.

Template Parameters
TType of parameter to fetch
Parameters
keyKey for the parameter on parameter-server
Returns
true for sucess and false if the parameter does not exist
Exceptions
GetROSParameterException

Definition at line 255 of file ros_parameter_handler.cpp.

◆ getPassword()

std::string psen_scan::RosParameterHandler::getPassword ( ) const

Getter method for password_.

Returns
std::string

Definition at line 274 of file ros_parameter_handler.cpp.

◆ getRequiredParamFromParamServer()

template<class T >
void psen_scan::RosParameterHandler::getRequiredParamFromParamServer ( const std::string &  key,
T &  param 
)

Gets one required ROS-parameter from parameter server.

Template Parameters
TType of parameter to fetch
Parameters
keyKey for the parameter on parameter-server
Exceptions
GetROSParameterException

Definition at line 231 of file ros_parameter_handler.cpp.

◆ getSensorIP()

std::string psen_scan::RosParameterHandler::getSensorIP ( ) const

Getter Method for sensor_ip_.

Returns
std::string

Definition at line 304 of file ros_parameter_handler.cpp.

◆ getSkip()

uint16_t psen_scan::RosParameterHandler::getSkip ( ) const

Getter method for skip_.

Returns
uint16_t

Definition at line 324 of file ros_parameter_handler.cpp.

◆ getXAxisRotation()

Degree psen_scan::RosParameterHandler::getXAxisRotation ( ) const

Getter Method for x_axis_rotation_.

Returns
double

Definition at line 354 of file ros_parameter_handler.cpp.

◆ updateAllParamsFromParamServer()

void psen_scan::RosParameterHandler::updateAllParamsFromParamServer ( )

Update all Parameters from ROS Parameter Server.

Definition at line 53 of file ros_parameter_handler.cpp.

Member Data Documentation

◆ angle_end_

PSENscanInternalAngle psen_scan::RosParameterHandler::angle_end_
private

End angle of measurement

Definition at line 56 of file ros_parameter_handler.h.

◆ angle_start_

PSENscanInternalAngle psen_scan::RosParameterHandler::angle_start_
private

Start angle of measurement

Definition at line 55 of file ros_parameter_handler.h.

◆ frame_id_

std::string psen_scan::RosParameterHandler::frame_id_
private

ROS Frame ID

Definition at line 53 of file ros_parameter_handler.h.

◆ host_ip_

uint32_t psen_scan::RosParameterHandler::host_ip_
private

IP-Adress of host machine

Definition at line 50 of file ros_parameter_handler.h.

◆ host_udp_port_

uint32_t psen_scan::RosParameterHandler::host_udp_port_
private

UDP Port on which packets from Laserscanner should be received

Definition at line 51 of file ros_parameter_handler.h.

◆ nh_

ros::NodeHandle const psen_scan::RosParameterHandler::nh_
private

Nodehandle through which parameters are fetched

Definition at line 48 of file ros_parameter_handler.h.

◆ password_

std::string psen_scan::RosParameterHandler::password_
private

Password for Laserscanner

Definition at line 49 of file ros_parameter_handler.h.

◆ sensor_ip_

std::string psen_scan::RosParameterHandler::sensor_ip_
private

IP-Adress of Safety laser scanner

Definition at line 52 of file ros_parameter_handler.h.

◆ skip_

uint16_t psen_scan::RosParameterHandler::skip_
private

How many incoming frames should be skipped (reduces publish rate)

Definition at line 54 of file ros_parameter_handler.h.

◆ x_axis_rotation_

Degree psen_scan::RosParameterHandler::x_axis_rotation_
private

Rotation of x-axis arround the center

Definition at line 57 of file ros_parameter_handler.h.


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


psen_scan
Author(s):
autogenerated on Mon Feb 28 2022 23:16:20