ddt::CommandLineParserBuilder Class Reference

#include <commandLineParserBuilder.hpp>

Public Member Functions
	CommandLineParserBuilder ()=default
virtual	~CommandLineParserBuilder ()
CommandLineParser	BuildRemoteClientParser (std::string &server_uri, std::string &image_widget, std::string &command, std::vector< std::string > &arguments, int32_t &timeout, bool &infinite)
CommandLineParser	BuildViewerParser (std::string &filename, std::string &local_broker_uri, std::string &remote_broker_uri, std::string &data_stream, std::string &server_uri, std::string &default_image_scale, bool &timestamp, std::string &overlay_file)
CommandLineParser	BuildSubscriberParser (std::string &broker, std::string &data_stream, int &frequency, std::string &remote_broker, int &mode, bool &statistics, bool &dump_data, std::string &dump_folder)
CommandLineParser	BuildPublisherParser (std::string &broker, std::string &data_stream, int &frequency, int &buffer_size, std::string &image_folder, int &mode, bool &checksum)
CommandLineParser	BuildBrokerParser (std::string &uri, std::string &config_file, bool &datastreams_list)

Detailed Description

Commandline parser builder class used to build a commandline parser

Constructor & Destructor Documentation

CommandLineParserBuilder()

ddt::CommandLineParserBuilder::CommandLineParserBuilder ( )

default

Constructor

~CommandLineParserBuilder()

CommandLineParserBuilder::~CommandLineParserBuilder ( )

virtualdefault

Destructor

Member Function Documentation

BuildBrokerParser()

CommandLineParser CommandLineParserBuilder::BuildBrokerParser	(	std::string &	uri,
		std::string &	config_file,
		bool &	datastreams_list
	)

Build commandline parser for the data broker

Parameters

uri	Publishing URI
config_file	Configuration file

BuildPublisherParser()

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

Build the commandline parser for the publisher

Parameters

broker	Broker URI
data_stream	Name of the data stream
frequency	Publishing frequency
buffer_size	Size of the ringbuffer
image_folder	Folder for FITS images
mode	Simulator mode
checksum	Flag indicating if the checksum is switched on or off

BuildRemoteClientParser()

CommandLineParser CommandLineParserBuilder::BuildRemoteClientParser	(	std::string &	server_uri,
		std::string &	image_widget,
		std::string &	command,
		std::vector< std::string > &	arguments,
		int32_t &	timeout,
		bool &	infinite
	)

Build the commandline parser for the remote client

Parameters

server_uri	URI to the Remote Control Server
image_widget	The name of the image widget
command	Command which is sent to the Remote Control Server
arguments	Command arguments
timeout	Timeout for the MAL client (reply time)
infinite	Infinite timeout for the MAL client (reply time is set to 24 h!)

BuildSubscriberParser()

CommandLineParser CommandLineParserBuilder::BuildSubscriberParser	(	std::string &	broker,
		std::string &	data_stream,
		int &	frequency,
		std::string &	remote_broker,
		int &	mode,
		bool &	statistics,
		bool &	dump_data,
		std::string &	dump_folder
	)

Build the commandline parser for the subscriber

Parameters

broker	Broker URI
data_stream	Name of the data stream
frequency	Reading frequency
remote_broker	URI of the remote broker
mode	Mode of the subscriber simulator
statistics	Flag to activate printing of statistic values
dump_data	Flag to activate dumping of received data as FITS files
dump_folder	Folder where to store the dumped FITS files

BuildViewerParser()

CommandLineParser CommandLineParserBuilder::BuildViewerParser	(	std::string &	filename,
		std::string &	local_broker_uri,
		std::string &	remote_broker_uri,
		std::string &	data_stream,
		std::string &	server_uri,
		std::string &	default_image_scale,
		bool &	timestamp,
		std::string &	overlay_file
	)

Build the commandline parser for the viewer

Parameters

filename	The name of a file to open
local_broker_uri	Local broker URI for datastream
remote_broker_uri	Remote broker URI to connect with
data_stream	The name of a data stream to attach
server_uri	Server URI for remote control interface
default_image_scale	Default scale for the image (specify as whole integers or in the form 1/2, 1/4 etc.)
timestamp	flag to display the timestamp of the received data sample
overlay_file	The overlay file to load

---

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

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