net::config::ConfigInstance Class Reference

#include <ConfigInstance.h>

Inheritance diagram for net::config::ConfigInstance:

Collaboration diagram for net::config::ConfigInstance:

Public Types
enum class	Role { SERVER , CLIENT }
using	Instance = ConfigInstance

Public Member Functions
	ConfigInstance (ConfigInstance &)=delete
	ConfigInstance (ConfigInstance &&)=delete
ConfigInstance &	operator= (ConfigInstance &)=delete
ConfigInstance &	operator= (ConfigInstance &&)=delete
Role	getRole ()
const std::string &	getInstanceName () const
void	setInstanceName (const std::string &instanceName)
bool	getDisabled () const
void	setDisabled (bool disabled=true)

Protected Member Functions
	ConfigInstance (const std::string &instanceName, Role role)
virtual	~ConfigInstance ()

Private Member Functions
CLI::App *	addSection (const std::string &name, const std::string &description)
CLI::App *	getSection (const std::string &name) const
void	required (CLI::App *section, bool req=true)
bool	getRequired () const

Private Attributes
uint8_t	requiredCount = 0
std::string	instanceName
Role	role
CLI::App *	instanceSc = nullptr
CLI::Option *	disableOpt = nullptr

Static Private Attributes
static const std::string	nameAnonymous = "<anonymous>"

Friends
class	net::config::ConfigSection

Detailed Description

Definition at line 63 of file ConfigInstance.h.

Member Typedef Documentation

Instance

using net::config::ConfigInstance::Instance = ConfigInstance

Definition at line 65 of file ConfigInstance.h.

Member Enumeration Documentation

Role

enum class net::config::ConfigInstance::Role

strong

Enumerator
SERVER
CLIENT

Definition at line 67 of file ConfigInstance.h.

{ SERVER, CLIENT };

Constructor & Destructor Documentation

ConfigInstance() [1/3]

net::config::ConfigInstance::ConfigInstance ( const std::string & instanceName, Role role )

explicitprotected

Definition at line 74 of file ConfigInstance.cpp.

        : instanceName(instanceName)
        , role(role) {
        instanceSc = utils::Config::addInstance(instanceName,
                                                std::string("Configuration for ")
                                                    .append(role == Role::SERVER ? "server" : "client")
                                                    .append(" instance '")
                                                    .append(instanceName)
                                                    .append("'"),
                                                "Instance");
 
        utils::Config::addStandardFlags(instanceSc);
        utils::Config::addHelp(instanceSc);
 
        disableOpt = instanceSc
                         ->add_flag_callback(
                             "--disabled{true}",
                             [this]() {
                                 utils::Config::disabled(instanceSc, disableOpt->as<bool>());
                             },
                             "Disable this instance")
                         ->trigger_on_parse()
                         ->default_val("false")
                         ->type_name("bool")
                         ->check(CLI::IsMember({"true", "false"}))
                         ->group(instanceSc->get_formatter()->get_label("Persistent Options"));
    }

~ConfigInstance()

net::config::ConfigInstance::~ConfigInstance ( )

protectedvirtual

Definition at line 102 of file ConfigInstance.cpp.

                                    {
        utils::Config::removeInstance(instanceSc);
    }

ConfigInstance() [2/3]

net::config::ConfigInstance::ConfigInstance ( ConfigInstance & )

delete

ConfigInstance() [3/3]

net::config::ConfigInstance::ConfigInstance ( ConfigInstance && )

delete

Member Function Documentation

addSection()

CLI::App * net::config::ConfigInstance::addSection ( const std::string & name, const std::string & description )

private

Definition at line 118 of file ConfigInstance.cpp.

                                                                                          {
        CLI::App* sectionSc = instanceSc //
                                  ->add_subcommand(name, description)
                                  ->fallthrough()
                                  ->configurable(false)
                                  ->allow_extras(false)
                                  ->group("Sections")
                                  ->disabled(this->instanceName.empty() || name.empty());
 
        sectionSc //
            ->option_defaults()
            ->configurable(!sectionSc->get_disabled());
 
        if (!sectionSc->get_disabled()) {
            utils::Config::addStandardFlags(sectionSc);
            utils::Config::addSimpleHelp(sectionSc);
        }
 
        return sectionSc;
    }

getDisabled()

bool net::config::ConfigInstance::getDisabled

(

)

const

Definition at line 165 of file ConfigInstance.cpp.

                                           {
        return disableOpt //
            ->as<bool>();
    }

getInstanceName()

const std::string & net::config::ConfigInstance::getInstanceName

(

)

const

Definition at line 110 of file ConfigInstance.cpp.

                                                           {
        return instanceName.empty() ? nameAnonymous : instanceName;
    }

getRequired()

bool net::config::ConfigInstance::getRequired ( ) const

private

Definition at line 157 of file ConfigInstance.cpp.

                                           {
        return requiredCount > 0;
    }

getRole()

ConfigInstance::Role net::config::ConfigInstance::getRole

(

)

Definition at line 106 of file ConfigInstance.cpp.

                                               {
        return role;
    }

getSection()

CLI::App * net::config::ConfigInstance::getSection ( const std::string & name ) const

private

Definition at line 161 of file ConfigInstance.cpp.

                                                                  {
        return instanceSc->get_subcommand_no_throw(name);
    }

operator=() [1/2]

ConfigInstance & net::config::ConfigInstance::operator= ( ConfigInstance && )

delete

operator=() [2/2]

ConfigInstance & net::config::ConfigInstance::operator= ( ConfigInstance & )

delete

required()

void net::config::ConfigInstance::required ( CLI::App * section, bool req = true )

private

Definition at line 139 of file ConfigInstance.cpp.

                                                           {
        if (req != section->get_required()) {
            if (req) {
                ++requiredCount;
                instanceSc->needs(section);
            } else {
                --requiredCount;
                instanceSc->remove_needs(section);
            }
 
            section->required(req);
 
            if (!disableOpt->as<bool>()) {
                utils::Config::required(instanceSc, requiredCount > 0);
            }
        }
    }

setDisabled()

void net::config::ConfigInstance::setDisabled

(

bool

disabled = true

)

Definition at line 170 of file ConfigInstance.cpp.

                                                  {
        disableOpt //
            ->default_val(disabled ? "true" : "false")
            ->clear();
 
        utils::Config::disabled(instanceSc, disabled);
    }

setInstanceName()

void net::config::ConfigInstance::setInstanceName

(

const std::string &

instanceName

)

Definition at line 114 of file ConfigInstance.cpp.

                                                                      {
        this->instanceName = instanceName;
    }

Friends And Related Symbol Documentation

net::config::ConfigSection

friend class net::config::ConfigSection

friend

Definition at line 108 of file ConfigInstance.h.

Member Data Documentation

disableOpt

CLI::Option* net::config::ConfigInstance::disableOpt = nullptr

private

Definition at line 106 of file ConfigInstance.h.

instanceName

std::string net::config::ConfigInstance::instanceName

private

Definition at line 100 of file ConfigInstance.h.

instanceSc

CLI::App* net::config::ConfigInstance::instanceSc = nullptr

private

Definition at line 105 of file ConfigInstance.h.

nameAnonymous

const std::string net::config::ConfigInstance::nameAnonymous = "<anonymous>"

staticprivate

Definition at line 101 of file ConfigInstance.h.

requiredCount

uint8_t net::config::ConfigInstance::requiredCount = 0

private

Definition at line 98 of file ConfigInstance.h.

role

Role net::config::ConfigInstance::role

private

Definition at line 103 of file ConfigInstance.h.

---

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

• net/config/ConfigInstance.h
• net/config/ConfigInstance.cpp