#include <string>

Include dependency graph for CommandLineInterfaceDefines.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	STARTUP_TEXT "Instrument control lib command line..." << std::endl << "Type 'help' to get a list of available commands" << std::endl;

#define	PROMPT_SYMBOL "$ "

#define	RESPONSE_INVALID_COMMAND " Command not found. Type 'help' to get list of available commands." << std::endl;

#define	MESSAGE_EXIT_CLI "Exit command line interface";

#define	HELP_MESSAGE_INDENTATION 10

#define	TIMEOUT_IN_MS 2000

Enumerations
enum	CLI_Commands { CLI_HELP , CLI_CONNECT , CLI_DISCONNECT , CLI_SUPPORTED_DEVICES , CLI_ACTIVE_DEVICES , CLI_SELECT_DEVICE , CLI_SEND_CUSTOM_COMMAND , CLI_GET_DEVICE_IDENTITY , CLI_QUIT , CLI_COMMAND_NOT_FOUND , CUSTOM_COMMAND1 }

Macro Definition Documentation

◆ HELP_MESSAGE_INDENTATION

#define HELP_MESSAGE_INDENTATION 10

Defines the indentation for the help message

#define MESSAGE_EXIT_CLI "Exit command line interface";

Message when exiting the CLI. E.g. when pressing CTRL + C.

#define PROMPT_SYMBOL "$ "

Prompt symbol which should be displayed.

#define RESPONSE_INVALID_COMMAND " Command not found. Type 'help' to get list of available commands." << std::endl;

Response message when invalid command was passed.

#define STARTUP_TEXT "Instrument control lib command line..." << std::endl << "Type 'help' to get a list of available commands" << std::endl;

Text shown when starting the command line interface.

#define TIMEOUT_IN_MS 2000

Enumerator
CLI_HELP	<help> Print function overview on the command line interface.
CLI_CONNECT	<Connect ip> Connect to a device. Capture its identifier and puts him to the list of connected devices.
CLI_DISCONNECT	<Disconnect ID> closes the connection with a device of a certain ID.
CLI_SUPPORTED_DEVICES	<supported_devices> prints the list of supported devices on the command line.
CLI_ACTIVE_DEVICES	<active_devices> prints a list with all active devices and its corresponding ID.
CLI_SELECT_DEVICE	<select_device ID> Selects a device according to its ID. All further commands are executed based on that device.
CLI_SEND_CUSTOM_COMMAND	<custom_command ID command args> Sends a custom VISA command to a device.
CLI_GET_DEVICE_IDENTITY	<get_device_identity ID> Return the device identity as string representation.
CLI_QUIT	<Quit> Closes the session.
CLI_COMMAND_NOT_FOUND	Dummy define to react on unknown commands.
CUSTOM_COMMAND1	Dummy define to add custom commands.