CommandLineInterface Class Reference

This class represents a command line interface to execute common functions of VISA devices. More...

#include <CommandLineInterface.h>

Collaboration diagram for CommandLineInterface:

Public Member Functions
	CommandLineInterface (PIL::Logging *logger)
	CommandLineInterface ()
bool	Start ()
	Start executing the command line interface. Input a raw SCPI command and execute. To see if a command is valid or not. More...

Static Public Member Functions
static void	PrintHelp (std::string &args)
	This method prints an overview of available commands on the command line interface. More...
static void	Connect (std::string &args)
	Connects to a device based on a certain IP address and adds it to the list of active devices. More...
static void	SendCustomCommand (std::string &args)
static void	Disconnect (std::string &args)
static void	Quit (std::string &args)
static void	GetSupportedDevices (std::string &args)
static void	ActiveDevices (std::string &args)
static void	SelectDevice (std::string &args)
static void	GetDeviceIdentifier (std::string &args)
static void	addCustomCommandLineOption (const char *identifier, const char *description, void(*func)(std::string &))
static std::vector< std::string >	splitArguments (std::string &args)

Detailed Description

This class represents a command line interface to execute common functions of VISA devices.

Constructor & Destructor Documentation

CommandLineInterface() [1/2]

CommandLineInterface::CommandLineInterface ( PIL::Logging *  logger )

explicit

CommandLineInterface() [2/2]

CommandLineInterface::CommandLineInterface ( )

explicit

Member Function Documentation

ActiveDevices()

void CommandLineInterface::ActiveDevices ( std::string &  args )

static

addCustomCommandLineOption()

void CommandLineInterface::addCustomCommandLineOption ( const char *  identifier, const char *  description, void(*)(std::string &)  func  )

static

Connect()

void CommandLineInterface::Connect ( std::string &  args )

static

Connects to a device based on a certain IP address and adds it to the list of active devices.

Parameters

args	only argument args[0] is chosen as IP addr.

Here is the call graph for this function:

Disconnect()

void CommandLineInterface::Disconnect ( std::string &  args )

static

Here is the call graph for this function:

Here is the caller graph for this function:

GetDeviceIdentifier()

void CommandLineInterface::GetDeviceIdentifier ( std::string &  args )

static

Here is the call graph for this function:

GetSupportedDevices()

void CommandLineInterface::GetSupportedDevices ( std::string &  args )

static

PrintHelp()

void CommandLineInterface::PrintHelp ( std::string &  args )

static

This method prints an overview of available commands on the command line interface.

Parameters

args	Arguments are ignored.

Quit()

void CommandLineInterface::Quit ( std::string &  args )

static

Here is the call graph for this function:

SelectDevice()

void CommandLineInterface::SelectDevice ( std::string &  args )

static

Here is the call graph for this function:

SendCustomCommand()

void CommandLineInterface::SendCustomCommand ( std::string &  args )

static

Here is the call graph for this function:

splitArguments()

std::vector< std::string > CommandLineInterface::splitArguments ( std::string &  args )

static

Here is the caller graph for this function:

Start()

bool CommandLineInterface::Start

(

)

Start executing the command line interface. Input a raw SCPI command and execute. To see if a command is valid or not.

Returns

true if CLI was successfully exited, else return false

Here is the call graph for this function:

---

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

• /home/runner/work/instrument_control_lib/instrument_control_lib/include/CommandLineInterface.h
• /home/runner/work/instrument_control_lib/instrument_control_lib/src/CommandLineInterface.cpp