Isis::ProgramLauncher Class Reference

Execute External Programs and Commands. More...

#include <ProgramLauncher.h>

Collaboration diagram for Isis::ProgramLauncher:

Static Public Member Functions
static void	RunIsisProgram (QString isisProgramName, QString arguments)
	Executes the Isis program with the given arguments. More...
static void	RunSystemCommand (QString commandLine)
	This runs arbitrary system commands. More...

Private Member Functions
	ProgramLauncher ()
	Construction is not allowed. More...
	~ProgramLauncher ()
	Destruction is not allowed. More...
	ProgramLauncher (ProgramLauncher &other)
	Copy construction is not allowed. More...
ProgramLauncher &	operator= (ProgramLauncher &other)
	Assignment is not allowed. More...

Static Private Member Functions
static IException	ProcessIsisMessageFromChild (QString code, QString msg)
	This interprets a message sent along the pipe from a child process to us (the parent). More...

Detailed Description

Execute External Programs and Commands.

This class is designed to handle running any other programs or commands.

Author

2010-12-03 Steven Lambright

History:

2010-12-03 Steven Lambright - Original version

History:

2011-08-19 Jeannie Backer - Modified unitTest to use $temporary variable instead of /tmp directory.

History:

2011-08-19 Kelvin Rodriguez - Added truth data for OS X 10.11 Part of proting to 10.11.

History:

2017-05-19 Christopher Combs - Modified unitTest.cpp: now creates unitTest.cub to perform tests on. Allows test to pass when not using the default data area. Fixes #4738.

Definition at line 34 of file ProgramLauncher.h.

Constructor & Destructor Documentation

ProgramLauncher() [1/2]

Isis::ProgramLauncher::ProgramLauncher ( )

private

Construction is not allowed.

~ProgramLauncher()

Isis::ProgramLauncher::~ProgramLauncher ( )

private

Destruction is not allowed.

ProgramLauncher() [2/2]

Isis::ProgramLauncher::ProgramLauncher ( ProgramLauncher &  other )

private

Copy construction is not allowed.

Parameters

other

Member Function Documentation

operator=()

ProgramLauncher& Isis::ProgramLauncher::operator= ( ProgramLauncher &  other )

private

Assignment is not allowed.

Parameters

other

Returns

ProcessIsisMessageFromChild()

IException Isis::ProgramLauncher::ProcessIsisMessageFromChild ( QString  code, QString  msg  )

staticprivate

This interprets a message sent along the pipe from a child process to us (the parent).

Parameters

code	The text code of the message - this is used to determine what the message contains.
msg	The data sent along with a code. This is a string, number, PvlGroup, Pvl, etc... really anything. It depends on the code parameter.

Definition at line 149 of file ProgramLauncher.cpp.

References Isis::IException::append(), Isis::Application::GuiLog(), Isis::Application::Log(), Isis::toInt(), and Isis::Application::UpdateProgress().

RunIsisProgram()

void Isis::ProgramLauncher::RunIsisProgram ( QString  programName, QString  parameters  )

static

Executes the Isis program with the given arguments.

This will handle logs, GUI updates, and similar tasks. Please use this even when there is no instance of Isis::Application, so long as the thing you are running has an Isis::Application (do not use this for qview, qnet, qtie, etc for now).

Please do not specify -pid.

Parameters

programName	The Isis program name to be run (i.e. catlab, cubeatt)
parameters	The arguments to give to the program that is being run

Definition at line 37 of file ProgramLauncher.cpp.

References Isis::IException::append(), Isis::FileName::expanded(), Isis::FileName::fileExists(), Isis::FileName::name(), and Isis::toString().

Referenced by Isis::Pipeline::Run().

RunSystemCommand()

void Isis::ProgramLauncher::RunSystemCommand ( QString  fullCommand )

static

This runs arbitrary system commands.

You can run programs like "qview" with this, or commands like "ls | grep *.cpp > out.txt". Please do not use this for Isis programs not in qisis.

Example: qview should use RunIsisProgram to run camstats. camstats should use RunSystemCommand to run qview.

Parameters

fullCommand

A string containing the command formatted like what you would type in a terminal

Definition at line 207 of file ProgramLauncher.cpp.

References Isis::toString().

Referenced by Isis::HelpTool::aboutProgram(), Isis::UserInterface::evaluateOption(), Isis::ControlMeasureEditWidget::saveChips(), Isis::ControlPointEdit::saveChips(), and Isis::GuiCubeParameter::ViewCube().

---

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

• src/base/objs/ProgramLauncher/ProgramLauncher.h
• src/base/objs/ProgramLauncher/ProgramLauncher.cpp