travesim::VisionConfigurer Class Reference

VisionConfigurer class definition. More...

#include "vision_configurer.hpp"

Inheritance diagram for travesim::VisionConfigurer:

Collaboration diagram for travesim::VisionConfigurer:

Public Member Functions
	VisionConfigurer (void)
	Construct a new VisionConfigurer object. More...
std::string	get_address (void)
	Get the vision configured address. More...
uint16_t	get_port (void)
	Get the vision configured port. More...
Public Member Functions inherited from travesim::AdapterConfigurer< travesim_adapters::VisionConfig >
	AdapterConfigurer (void)
	Construct a new AdapterConfigurer object. More...
	AdapterConfigurer (std::string config_namespace)
	Construct a new AdapterConfigurer object. More...
bool	get_reset (void)
	Get the reset config. More...

Friends
std::ostream &	operator<< (std::ostream &output, const VisionConfigurer &vision_conf)
	Output stream operator overloading. More...

Additional Inherited Members
Protected Attributes inherited from travesim::AdapterConfigurer< travesim_adapters::VisionConfig >
bool	reconfigured
travesim_adapters::VisionConfig	config
boost::recursive_mutex	mutex

Detailed Description

VisionConfigurer class definition.

Definition at line 28 of file vision_configurer.hpp.

Constructor & Destructor Documentation

VisionConfigurer()

travesim::VisionConfigurer::VisionConfigurer

(

void

)

Construct a new VisionConfigurer object.

Definition at line 28 of file vision_configurer.cpp.

                                       : AdapterConfigurer<travesim_adapters::VisionConfig>::AdapterConfigurer(
        VISION_CONFIGURER_NAMESPACE) {
}

Member Function Documentation

get_address()

std::string travesim::VisionConfigurer::get_address

(

void

)

Get the vision configured address.

Returns

std::string address string

Definition at line 32 of file vision_configurer.cpp.

                                            {
    boost::recursive_mutex::scoped_lock scoped_lock(this->mutex);

    std::string address = this->config.multicast_address;

    IPValidation validation = check_valid_ip(address, MIN_MULTICAST_ADDRESS, MAX_MULTICAST_ADDRESS);

    if (validation == IPValidation::VALID) {
        return address;
    } else {
        ROS_ERROR_STREAM(get_error_msg(validation));

        return INVALID_ADDRESS;
    }
}

References travesim::check_valid_ip(), travesim::AdapterConfigurer< travesim_adapters::VisionConfig >::config, travesim::get_error_msg(), INVALID_ADDRESS, MAX_MULTICAST_ADDRESS, MIN_MULTICAST_ADDRESS, travesim::AdapterConfigurer< travesim_adapters::VisionConfig >::mutex, and travesim::VALID.

Here is the call graph for this function:

Here is the caller graph for this function:

get_port()

uint16_t travesim::VisionConfigurer::get_port

(

void

)

Get the vision configured port.

Returns

uint16_t port number

Definition at line 48 of file vision_configurer.cpp.

                                        {
    boost::recursive_mutex::scoped_lock scoped_lock(this->mutex);
    return this->config.multicast_port;
}

References travesim::AdapterConfigurer< travesim_adapters::VisionConfig >::config, and travesim::AdapterConfigurer< travesim_adapters::VisionConfig >::mutex.

Here is the caller graph for this function:

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  output, const VisionConfigurer &  vision_conf  )

friend

Output stream operator overloading.

Definition at line 53 of file vision_configurer.cpp.

                                                                                 {
    output << "Vision Endpoint: " << vision_conf.config.multicast_address;
    output << ":" << vision_conf.config.multicast_port << std::endl;
    output << "Reset: " << ((vision_conf.config.reset || vision_conf.reconfigured) ? "True" : "False") << std::endl;

    return output;
}

---

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

• include/travesim_adapters/configurers/vision_configurer.hpp
• src/lib/configurers/vision_configurer.cpp