net::rc::config::ConfigAddress< ConfigAddressTypeT > Class Template Reference

#include <ConfigAddress.h>

Inheritance diagram for net::rc::config::ConfigAddress< ConfigAddressTypeT >:

Collaboration diagram for net::rc::config::ConfigAddress< ConfigAddressTypeT >:

Public Member Functions
ConfigAddress &	setSocketAddress (const SocketAddress &socketAddress)
ConfigAddress &	setBtAddress (const std::string &btAddress)
std::string	getBtAddress () const
ConfigAddress &	setChannel (uint8_t channel)
uint8_t	getChannel () const

Protected Member Functions
	ConfigAddress (net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
ConfigAddress &	setBtAddressRequired (bool required=true)
ConfigAddress &	setChannelRequired (bool required=true)

Protected Attributes
CLI::Option *	btAddressOpt = nullptr
CLI::Option *	channelOpt = nullptr

Private Types
using	Super = ConfigAddressTypeT<net::rc::SocketAddress>

Private Member Functions
SocketAddress *	init () final

Detailed Description

template<template< typename SocketAddressT > typename ConfigAddressTypeT>
class net::rc::config::ConfigAddress< ConfigAddressTypeT >

Definition at line 77 of file ConfigAddress.h.

Member Typedef Documentation

Super

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

using net::rc::config::ConfigAddress< ConfigAddressTypeT >::Super = ConfigAddressTypeT<net::rc::SocketAddress>

private

Definition at line 79 of file ConfigAddress.h.

Constructor & Destructor Documentation

ConfigAddress()

template<template< typename SocketAddress > typename ConfigAddressType>

net::rc::config::ConfigAddress< ConfigAddressType >::ConfigAddress ( net::config::ConfigInstance * instance, const std::string & addressOptionName, const std::string & addressOptionDescription )

explicitprotected

Definition at line 59 of file ConfigAddress.cpp.

        : Super(instance, addressOptionName, addressOptionDescription) {
        btAddressOpt = Super::addOption( //
            "--host",
            "Bluetooth address",
            "xx:xx:xx:xx:xx:xx",
            "00:00:00:00:00:00",
            CLI::TypeValidator<std::string>());
        channelOpt = Super::addOption( //
            "--channel",
            "Channel number",
            "channel");
    }

References btAddressOpt, and channelOpt.

Member Function Documentation

getBtAddress()

template<template< typename SocketAddress > typename ConfigAddressType>

std::string net::rc::config::ConfigAddress< ConfigAddressType >::getBtAddress

(

)

const

Definition at line 104 of file ConfigAddress.cpp.

                                                                   {
        return btAddressOpt->as<std::string>();
    }

References btAddressOpt.

getChannel()

template<template< typename SocketAddress > typename ConfigAddressType>

uint8_t net::rc::config::ConfigAddress< ConfigAddressType >::getChannel

(

)

const

Definition at line 121 of file ConfigAddress.cpp.

                                                               {
        return channelOpt->as<uint8_t>();
    }

References channelOpt.

init()

template<template< typename SocketAddress > typename ConfigAddressType>

SocketAddress * net::rc::config::ConfigAddress< ConfigAddressType >::init ( )

finalprivate

Definition at line 76 of file ConfigAddress.cpp.

                                                          {
        SocketAddress* socketAddress = new SocketAddress(btAddressOpt->as<std::string>(), channelOpt->as<uint8_t>());
        socketAddress->init();
 
        return socketAddress;
    }

References btAddressOpt, channelOpt, net::rc::SocketAddress::init(), and net::rc::SocketAddress::SocketAddress().

Here is the call graph for this function:

setBtAddress()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::rc::config::ConfigAddress< ConfigAddressType >::setBtAddress

(

const std::string &

btAddress

)

Definition at line 92 of file ConfigAddress.cpp.

                                                                                                               {
        const utils::PreserveErrno preserveErrno;
 
        btAddressOpt //
            ->default_val(btAddress)
            ->clear();
        Super::required(btAddressOpt, false);
 
        return *this;
    }

Referenced by setSocketAddress().

Here is the caller graph for this function:

setBtAddressRequired()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::rc::config::ConfigAddress< ConfigAddressType >::setBtAddressRequired ( bool required = true )

protected

Definition at line 126 of file ConfigAddress.cpp.

                                                                                                          {
        Super::required(btAddressOpt, required);
 
        return *this;
    }

References btAddressOpt.

Referenced by net::rc::stream::config::ConfigSocketClient::ConfigSocketClient().

Here is the caller graph for this function:

setChannel()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::rc::config::ConfigAddress< ConfigAddressType >::setChannel

(

uint8_t

channel

)

Definition at line 109 of file ConfigAddress.cpp.

                                                                                                  {
        const utils::PreserveErrno preserveErrno;
 
        channelOpt //
            ->default_val<int>(channel)
            ->clear();
        Super::required(channelOpt, false);
 
        return *this;
    }

References channelOpt.

Referenced by setSocketAddress().

Here is the caller graph for this function:

setChannelRequired()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::rc::config::ConfigAddress< ConfigAddressType >::setChannelRequired ( bool required = true )

protected

Definition at line 133 of file ConfigAddress.cpp.

                                                                                                        {
        Super::required(channelOpt, required);
 
        return *this;
    }

References channelOpt.

Referenced by net::rc::stream::config::ConfigSocketClient::ConfigSocketClient(), and net::rc::stream::config::ConfigSocketServer::ConfigSocketServer().

Here is the caller graph for this function:

setSocketAddress()

template<template< typename SocketAddress > typename ConfigAddressType>

ConfigAddress< ConfigAddressType > & net::rc::config::ConfigAddress< ConfigAddressType >::setSocketAddress

(

const SocketAddress &

socketAddress

)

Definition at line 84 of file ConfigAddress.cpp.

                                                                                                                           {
        setBtAddress(socketAddress.getBtAddress());
        setChannel(socketAddress.getChannel());
 
        return *this;
    }

References net::rc::SocketAddress::getBtAddress(), net::rc::SocketAddress::getChannel(), setBtAddress(), and setChannel().

Here is the call graph for this function:

Member Data Documentation

btAddressOpt

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

CLI::Option* net::rc::config::ConfigAddress< ConfigAddressTypeT >::btAddressOpt = nullptr

protected

Definition at line 102 of file ConfigAddress.h.

Referenced by ConfigAddress(), getBtAddress(), init(), and setBtAddressRequired().

channelOpt

template<template< typename SocketAddressT > typename ConfigAddressTypeT>

CLI::Option* net::rc::config::ConfigAddress< ConfigAddressTypeT >::channelOpt = nullptr

protected

Definition at line 103 of file ConfigAddress.h.

Referenced by ConfigAddress(), getChannel(), init(), setChannel(), and setChannelRequired().

---

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

• net/rc/config/ConfigAddress.h
• net/rc/config/ConfigAddress.cpp