CommandLineInterfaceDefines.h

Go to the documentation of this file.

 
#pragma once
 
#include <string> // std::string
 
#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
 
#ifdef __WIN32__
#define TIMEOUT_IN_MS   0 // TODO timeout not supported yet on windows
#else
#define TIMEOUT_IN_MS   2000
#endif
 
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,
};
 
struct CLICommandStruct
{
    CLI_Commands identifier;
    const char *command;
    const char *description;
 
    void (*func)(std::string &);
} typedef CLICommandStruct;