openfluid::utils::ExternalProgram Class Reference

Detailed Description

Management of external programs

#include <utils/ExternalProgram.hpp>

Public Types
enum	RegisteredPrograms {   CMakeProgram, ZipProgram, SevenZipProgram, GnuplotProgram,   GoogleEarthProgram, GccProgram, PdfLatexProgram, BibTexProgram,   Latex2HTMLProgram, GitProgram, GrassGisProgram }

Public Member Functions
	ExternalProgram ()=delete
	ExternalProgram (const QStringList &ProgramNames, const QStringList &SearchPaths=QStringList(), bool UsePathEnv=true)
	ExternalProgram (const QString &ProgramName, const QStringList &SearchPaths=QStringList(), bool UsePathEnv=true)
	~ExternalProgram ()
bool	isFound () const
void	searchForProgram ()
QString	getFullProgramPath () const

Static Public Member Functions
static ExternalProgram	getRegisteredProgram (RegisteredPrograms Prog, const QStringList &SearchPaths=QStringList(), bool UsePathEnv=true)
static QString	findUsingPATHEnvVar (const QStringList &ProgramNames)
static QString	findUsingPathsList (const QStringList &ProgramNames, const QStringList &PathsList)

Member Enumeration Documentation

RegisteredPrograms

enum openfluid::utils::ExternalProgram::RegisteredPrograms

List of pre-registered external programs

Enumerator
CMakeProgram
ZipProgram
SevenZipProgram
GnuplotProgram
GoogleEarthProgram
GccProgram
PdfLatexProgram
BibTexProgram
Latex2HTMLProgram
GitProgram
GrassGisProgram

Constructor & Destructor Documentation

ExternalProgram() [1/3]

openfluid::utils::ExternalProgram::ExternalProgram ( )

delete

ExternalProgram() [2/3]

openfluid::utils::ExternalProgram::ExternalProgram	(	const QStringList &	ProgramNames,
		const QStringList &	SearchPaths = QStringList(),
		bool	UsePathEnv = true
	)

Constructor for a given external programs. Automatically searches for the program at construction

Parameters

[in]	ProgramNames	The possible names of the program to find
[in]	SearchPaths	The list of paths to search. Default value is an empty list
[in]	UsePathEnv	Enable the use of PATH environment variable to search for the program. Default value is true.

ExternalProgram() [3/3]

openfluid::utils::ExternalProgram::ExternalProgram	(	const QString &	ProgramName,
		const QStringList &	SearchPaths = QStringList(),
		bool	UsePathEnv = true
	)

Constructor for a given external programs. Automatically searches for the program at construction

Parameters

[in]	ProgramName	The name of the program to find
[in]	SearchPaths	The list of paths to search. Default value is an empty list
[in]	UsePathEnv	Enable the use of PATH environment variable to search for the program. Default value is true.

~ExternalProgram()

openfluid::utils::ExternalProgram::~ExternalProgram

(

)

Member Function Documentation

findUsingPATHEnvVar()

static QString openfluid::utils::ExternalProgram::findUsingPATHEnvVar ( const QStringList &  ProgramNames )

static

Finds a program using the PATH environment variable

Parameters

[in]

ProgramNames

The list of the potential program names of the program to find

Returns

The full path of the first found program

findUsingPathsList()

static QString openfluid::utils::ExternalProgram::findUsingPathsList ( const QStringList &  ProgramNames, const QStringList &  PathsList  )

static

Finds a program using a given paths list

Parameters

[in]	ProgramNames	The list of the potential program names of the program to find
[in]	PathsList	The list of paths to search

Returns

The full path of the first found program

getFullProgramPath()

QString openfluid::utils::ExternalProgram::getFullProgramPath ( ) const

inline

Returns the full path of the program

Returns

the full path of the program if it has been found, otherwise an empty string

getRegisteredProgram()

static ExternalProgram openfluid::utils::ExternalProgram::getRegisteredProgram ( RegisteredPrograms  Prog, const QStringList &  SearchPaths = QStringList(), bool  UsePathEnv = true  )

static

Returns an ExternalProgram object initialized with the registered program to find

Parameters

[in]	Prog	The registered program to find
[in]	SearchPaths	The list of paths to search. Default value is an empty list
[in]	UsePathEnv	Enable the use of PATH environment variable to search for the registered program. Default value is true.

Returns

An ExternalProgram object initialized with the registered program to find

isFound()

bool openfluid::utils::ExternalProgram::isFound ( ) const

inline

Returns true if the current program has been found

Returns

true if the current program has been found

searchForProgram()

void openfluid::utils::ExternalProgram::searchForProgram

(

)

Searches for the program

---

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

• utils/ExternalProgram.hpp