ddt::CommandLineParser Class Reference

#include <commandLineParser.hpp>

Inheritance diagram for ddt::CommandLineParser:

Public Member Functions
	CommandLineParser ()=default
virtual	~CommandLineParser ()
void	setOptions (std::string &uri)
	Set the options for a data broker application. More...
void	setOptions (std::string &filename, std::string &data_stream)
	Set the command line options for viewer applications. More...
void	setOptions (std::string &broker, std::string &data_stream, int &frequency)
	Set the options for a data transfer application. More...
void	setOptions (std::string &broker, std::string &data_stream, int &frequency, std::string &remote_broker, int &mode, bool &statistics)
	Set the options for a subscriber application. More...
void	setOptions (std::string &broker, std::string &data_stream, int &frequency, int &buffer_size, std::string &image_folder, int &mode, bool &checksum)
	Set the options for a publisher application with image folder. More...
int	parse (int argc, char *argv[])
	Parse the given commandline input. More...

Protected Member Functions
void	setOptions ()
	Set standard command line options. More...

Protected Attributes
po::options_description	options
po::positional_options_description	positional_options

Detailed Description

Commandline parser class using for parsing arguments on the commandline

Constructor & Destructor Documentation

CommandLineParser()

ddt::CommandLineParser::CommandLineParser ( )

default

Constructor

~CommandLineParser()

CommandLineParser::~CommandLineParser ( )

virtualdefault

Destructor

Member Function Documentation

parse()

int CommandLineParser::parse	(	int	argc,
		char *	argv[]
	)

Parse the given commandline input.

Parses the input and stores it in the options object.

Parameters

argc	Number of arguments.
argv	Array containing the arguments.

Returns

int Additional flag for debug (1) etc.

setOptions() [1/6]

void CommandLineParser::setOptions ( )

protected

Set standard command line options.

This method adds the help and debug argument to the options.

setOptions() [2/6]

void ddt::CommandLineParser::setOptions	(	std::string &	broker,
		std::string &	data_stream,
		int &	frequency
	)

Set the options for a data transfer application.

Initializes the options object if not already done, and adds the argument options broker, data_stream and frequency.

Parameters

broker	Takes the URI of the broker.
data_stream	Takes the name of the data stream.
frequency	Takes the reading/writing frequency.

setOptions() [3/6]

void CommandLineParser::setOptions	(	std::string &	broker,
		std::string &	data_stream,
		int &	frequency,
		int &	buffer_size,
		std::string &	image_folder,
		int &	mode,
		bool &	checksum
	)

Set the options for a publisher application with image folder.

Initializes the options object if not already done. Calls setOptions(std::string&, std::string&, int&, std::string&) with broker, data_stream, frequency and buffer_size. Adds then image_folder as argument.

Parameters

broker	Takes the URI of the broker.
data_stream	Takes the name of the data stream.
frequency	Takes the reading/writing frequency.
buffer_size	Takes number of elements in the buffer.
image_folder	Takes the path to the image folder.
mode	Simulator mode.
checksum	Turns the computation of the checksum on.

setOptions() [4/6]

void CommandLineParser::setOptions	(	std::string &	broker,
		std::string &	data_stream,
		int &	frequency,
		std::string &	remote_broker,
		int &	mode,
		bool &	statistics
	)

Set the options for a subscriber application.

Initializes the options object if not already done. Calls setOptions(std::string&, std::string&, int&) with broker, data_stream and frequency. Adds then remote_broker as argument.

Parameters

broker	Takes the URI of the broker.
data_stream	Takes the name of the data stream.
frequency	Takes the reading/writing frequency.
remote_broker	Takes the URI to a remote Broker.
mode	Use case of the subscriber simulator.
statistics	Query the statistics.

setOptions() [5/6]

void CommandLineParser::setOptions	(	std::string &	filename,
		std::string &	data_stream
	)

Set the command line options for viewer applications.

Initializes the options object and adds the argument options filename and data_stream.

Parameters

filename	The file to load.
data_stream	The data stream.

setOptions() [6/6]

void CommandLineParser::setOptions

(

std::string &

uri

)

Set the options for a data broker application.

Parameters

uri	Takes the uri of the broker.

Member Data Documentation

options

po::options_description ddt::CommandLineParser::options

protected

Options

positional_options

po::positional_options_description ddt::CommandLineParser::positional_options

protected

Positional Options

---

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

• utils/commandlinelib/src/include/ddt/commandLineParser.hpp
• utils/commandlinelib/src/commandLineParser.cpp