OpenDaVINCI  4.16.0
odcontext::base::CommandLineInterface Class Reference

#include <CommandLineInterface.h>

Inheritance diagram for odcontext::base::CommandLineInterface:
Inheritance graph

Public Member Functions

 CommandLineInterface ()
 
virtual ~CommandLineInterface ()
 
bool parse (const int32_t &argc, char **argv)
 
virtual const
odcore::base::KeyValueConfiguration 
getConfiguration () const
 
virtual const string getMulticastGroup () const
 
virtual uint32_t getCID () const
 
virtual bool isVerbose () const
 
virtual bool isSupercomponent () const
 

Detailed Description

This class provides access to the RuntimeControl using the CLI.

Constructor & Destructor Documentation

odcontext::base::CommandLineInterface::CommandLineInterface ( )
odcontext::base::CommandLineInterface::~CommandLineInterface ( )
virtual

Member Function Documentation

uint32_t odcontext::base::CommandLineInterface::getCID ( ) const
virtual

This method returns the conference ID (CID).

Returns
CID.

Implements odcontext::base::RuntimeControlInterface.

const KeyValueConfiguration odcontext::base::CommandLineInterface::getConfiguration ( ) const
virtual

This method returns the configuration to be used for the SystemContext.

Returns
KeyValueConfiguration to be used.

Implements odcontext::base::RuntimeControlInterface.

const string odcontext::base::CommandLineInterface::getMulticastGroup ( ) const
virtual

This method returns the multicast group to be used.

Returns
Multicast group.

Implements odcontext::base::RuntimeControlInterface.

bool odcontext::base::CommandLineInterface::isSupercomponent ( ) const
virtual

This method returns true if the RuntimeControl should provide supercomponent-functionality.

Returns
true if the RuntimeControl should provide supercomponent functionality.

Implements odcontext::base::RuntimeControlInterface.

bool odcontext::base::CommandLineInterface::isVerbose ( ) const
virtual

This method returns true if the RuntimeControl should be verbose.

Returns
true if the RuntimeControl should be verbose.

Implements odcontext::base::RuntimeControlInterface.

bool odcontext::base::CommandLineInterface::parse ( const int32_t &  argc,
char **  argv 
)

This method parses the commandline to get necessary information.

Parameters
argcNumber of command line arguments.
argvCommandline arguments.
Returns
true if the arguments provided by the commandline could be successfully parsed.

References odcore::base::CommandLineParser::addCommandLineArgument(), odcore::base::CommandLineParser::getCommandLineArgument(), odcore::base::CommandLineArgument::getValue(), odcore::base::CommandLineArgument::isSet(), odcore::base::CommandLineParser::parse(), and odcore::base::KeyValueConfiguration::readFrom().