TwiceAsNice  2019-02-18
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Basda::Microgate::BasicCommandStarter Class Referenceabstract

This abstract class provides helper methods. More...

#include <BasicCommandStarter.h>

Inheritance diagram for Basda::Microgate::BasicCommandStarter:
Inheritance graph
Collaboration diagram for Basda::Microgate::BasicCommandStarter:
Collaboration graph

Public Member Functions

 BasicCommandStarter ()
 
virtual ~BasicCommandStarter ()=0
 
 BasicCommandStarter ()
 
virtual ~BasicCommandStarter ()=0
 

Static Public Member Functions

static void printError (const std::string &message)
 
static void printError (const std::string &message)
 

Protected Member Functions

std::string toOption (const std::string &longArg, const std::string &shortArg)
 
boost::program_options::options_description createAllowedBasicOptions ()
 
bool areBasicArgumentsGiven (const boost::program_options::variables_map &vm)
 
void printUsage (const std::string &programName, const boost::program_options::options_description &desc, const std::string &missingOptionExample)
 
std::string toOption (const std::string &longArg, const std::string &shortArg)
 
boost::program_options::options_description createAllowedBasicOptions ()
 
bool areBasicArgumentsGiven (const boost::program_options::variables_map &vm)
 
void printUsage (const std::string &programName, const boost::program_options::options_description &desc, const std::string &missingOptionExample)
 

Protected Attributes

std::string long_argument_bcu_
 
std::string short_argument_bcu_
 
std::string option_bcu_
 
std::string long_argument_port_
 
std::string short_argument_port_
 
std::string option_port_
 
std::string long_argument_local_port_
 
std::string short_argument_local_port_
 
std::string option_local_port_
 
std::string long_argument_message_
 
std::string short_argument_message_
 
std::string option_message_
 
std::string long_argument_memory_
 
std::string short_argument_memory_
 
std::string option_memory_
 

Detailed Description

This abstract class provides helper methods.

Constructor & Destructor Documentation

◆ BasicCommandStarter() [1/2]

Basda::Microgate::BasicCommandStarter::BasicCommandStarter ( )
inline

◆ ~BasicCommandStarter() [1/2]

Basda::Microgate::BasicCommandStarter::~BasicCommandStarter ( )
pure virtual

◆ BasicCommandStarter() [2/2]

Basda::Microgate::BasicCommandStarter::BasicCommandStarter ( )
inline

◆ ~BasicCommandStarter() [2/2]

virtual Basda::Microgate::BasicCommandStarter::~BasicCommandStarter ( )
pure virtual

Member Function Documentation

◆ areBasicArgumentsGiven() [1/2]

bool Basda::Microgate::BasicCommandStarter::areBasicArgumentsGiven ( const boost::program_options::variables_map &  vm)
inlineprotected

◆ areBasicArgumentsGiven() [2/2]

bool Basda::Microgate::BasicCommandStarter::areBasicArgumentsGiven ( const boost::program_options::variables_map &  vm)
inlineprotected

◆ createAllowedBasicOptions() [1/2]

boost::program_options::options_description Basda::Microgate::BasicCommandStarter::createAllowedBasicOptions ( )
inlineprotected

◆ createAllowedBasicOptions() [2/2]

boost::program_options::options_description Basda::Microgate::BasicCommandStarter::createAllowedBasicOptions ( )
inlineprotected

◆ printError() [1/2]

static void Basda::Microgate::BasicCommandStarter::printError ( const std::string &  message)
inlinestatic

◆ printError() [2/2]

static void Basda::Microgate::BasicCommandStarter::printError ( const std::string &  message)
inlinestatic

◆ printUsage() [1/2]

void Basda::Microgate::BasicCommandStarter::printUsage ( const std::string &  programName,
const boost::program_options::options_description &  desc,
const std::string &  missingOptionExample 
)
inlineprotected

◆ printUsage() [2/2]

void Basda::Microgate::BasicCommandStarter::printUsage ( const std::string &  programName,
const boost::program_options::options_description &  desc,
const std::string &  missingOptionExample 
)
inlineprotected

◆ toOption() [1/2]

std::string Basda::Microgate::BasicCommandStarter::toOption ( const std::string &  longArg,
const std::string &  shortArg 
)
inlineprotected

◆ toOption() [2/2]

std::string Basda::Microgate::BasicCommandStarter::toOption ( const std::string &  longArg,
const std::string &  shortArg 
)
inlineprotected

Member Data Documentation

◆ long_argument_bcu_

std::string Basda::Microgate::BasicCommandStarter::long_argument_bcu_
protected

◆ long_argument_local_port_

std::string Basda::Microgate::BasicCommandStarter::long_argument_local_port_
protected

◆ long_argument_memory_

std::string Basda::Microgate::BasicCommandStarter::long_argument_memory_
protected

◆ long_argument_message_

std::string Basda::Microgate::BasicCommandStarter::long_argument_message_
protected

◆ long_argument_port_

std::string Basda::Microgate::BasicCommandStarter::long_argument_port_
protected

◆ option_bcu_

std::string Basda::Microgate::BasicCommandStarter::option_bcu_
protected

◆ option_local_port_

std::string Basda::Microgate::BasicCommandStarter::option_local_port_
protected

◆ option_memory_

std::string Basda::Microgate::BasicCommandStarter::option_memory_
protected

◆ option_message_

std::string Basda::Microgate::BasicCommandStarter::option_message_
protected

◆ option_port_

std::string Basda::Microgate::BasicCommandStarter::option_port_
protected

◆ short_argument_bcu_

std::string Basda::Microgate::BasicCommandStarter::short_argument_bcu_
protected

◆ short_argument_local_port_

std::string Basda::Microgate::BasicCommandStarter::short_argument_local_port_
protected

◆ short_argument_memory_

std::string Basda::Microgate::BasicCommandStarter::short_argument_memory_
protected

◆ short_argument_message_

std::string Basda::Microgate::BasicCommandStarter::short_argument_message_
protected

◆ short_argument_port_

std::string Basda::Microgate::BasicCommandStarter::short_argument_port_
protected

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