phoenix_program_call.h File Reference

#include "ProgramCall.h"

Include dependency graph for phoenix_program_call.h:

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

Go to the source code of this file.

Typedefs
typedef std::vector< ProgramCall >	VecProgramCall
	Vector of program call.
typedef std::vector< VecProgramCall >	VecVecProgramCall
	Vector of vector of program call.

Functions
void	phoenix_program_addcall (VecProgramCall &vecCall, const PString &name, const PString &command, const PPath &workingDirectory=PPath("./"), const PPath &logFile=PPath())
	Add a program call.
void	phoenix_program_call (ProgramCall &call)
	Call a program.
void	phoenix_program_callParallel (VecProgramCall &vecCall, size_t nbThread)
	Exectute programs on several threads.
void	phoenix_program_callParallelProgressBar (VecProgramCall &vecCall, size_t nbThread)
	Exectute programs on several threads (with a multithread progress bar)
void	phoenix_program_callParallelProgressBar (VecVecProgramCall &vecVecProgramCall)
	Exectute programs on several threads (with a multithread progress bar)
void	phoenix_program_callVec (VecProgramCall &vecCall)
	Call a vector of program.
size_t	phoenix_program_getNbCall (const VecVecProgramCall &vecCall)
	Get the number of call.
size_t	phoenix_program_getNbCallExitStatusType (const VecProgramCall &vecCall, int result)
	Get number of call result of a given type.
size_t	phoenix_program_getNbCallExitStatusType (const VecVecProgramCall &vecCall, int result)
	Get number of call result of a given type.
size_t	phoenix_program_getNbSuccessCall (const VecProgramCall &vecCall)
	Get the number of success call.
size_t	phoenix_program_getNbSuccessCall (const VecVecProgramCall &vecCall)
	Get the number of success call.

Typedef Documentation

VecProgramCall

typedef std::vector<ProgramCall> VecProgramCall

Vector of program call.

Definition at line 13 of file phoenix_program_call.h.

VecVecProgramCall

typedef std::vector<VecProgramCall> VecVecProgramCall

Vector of vector of program call.

Definition at line 15 of file phoenix_program_call.h.

Function Documentation

phoenix_program_addcall()

void phoenix_program_addcall	(	VecProgramCall &	vecCall,
		const PString &	name,
		const PString &	command,
		const PPath &	workingDirectory,
		const PPath &	logFile )

Add a program call.

Parameters

[out]	vecCall	: vector of program call
	name	: name of the call
	command	: command of the call
	workingDirectory	: directory in which to call the program
	logFile	: log file of the call

Definition at line 108 of file phoenix_program_call.cpp.

{
        ProgramCall call;
        call.setName(name);
        call.setCommand(command);
        call.setWorkingDirectory(workingDirectory);
        call.setLogFile(logFile);
        call.setExitStatus(0);
        vecCall.push_back(call);
}

References ProgramCall::setCommand(), ProgramCall::setExitStatus(), ProgramCall::setLogFile(), ProgramCall::setName(), and ProgramCall::setWorkingDirectory().

Here is the call graph for this function:

phoenix_program_call()

void phoenix_program_call

(

ProgramCall &

call

)

Call a program.

Parameters

[out]

call

: program to be executed

Definition at line 23 of file phoenix_program_call.cpp.

                                             {
        PString command(call.getCommand());
        if(call.getWorkingDirectory() != ""){
                command = "cd " + PString(call.getWorkingDirectory()) + ";" + command;
        }
        if(call.getLogFile() != ""){
                PString logContent("");
                call.setExitStatus(phoenix_popen(logContent, command));
                call.getLogFile().saveFileContent(logContent);
        }else{
                std::cout << termCyan() << "Call command '"<<command<<"'" << termDefault() << std::endl;
                call.setExitStatus(system(command.c_str()));
        }
}

References ProgramCall::getCommand(), ProgramCall::getLogFile(), ProgramCall::getWorkingDirectory(), and ProgramCall::setExitStatus().

Referenced by phoenix_program_callVec(), and phoenix_program_callVecProgress().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_program_callParallel()

void phoenix_program_callParallel	(	VecProgramCall &	vecCall,
		size_t	nbThread )

Exectute programs on several threads.

Parameters

[out]	vecCall	: vector of commands to be exectuted
	nbThread	: number of thread to be used

Definition at line 51 of file phoenix_program_call.cpp.

                                                                            {
        if(vecCall.size() == 0lu){return;}
        lauchParallelThread(vecCall, nbThread, phoenix_program_callVec);
}

References lauchParallelThread(), and phoenix_program_callVec().

Here is the call graph for this function:

phoenix_program_callParallelProgressBar() [1/2]

void phoenix_program_callParallelProgressBar	(	VecProgramCall &	vecCall,
		size_t	nbThread )

Exectute programs on several threads (with a multithread progress bar)

Parameters

[out]	vecCall	: vector of commands to be exectuted
	nbThread	: number of thread to be used

Definition at line 94 of file phoenix_program_call.cpp.

                                                                                       {
        if(vecCall.size() == 0lu){return;}
        VecVecProgramCall vecVecProgramCall;
        phoenix_vector_split(vecVecProgramCall, vecCall, nbThread);
        phoenix_program_callParallelProgressBar(vecVecProgramCall);
}

References phoenix_program_callParallelProgressBar().

Here is the call graph for this function:

phoenix_program_callParallelProgressBar() [2/2]

void phoenix_program_callParallelProgressBar

(

VecVecProgramCall &

vecVecProgramCall

)

Exectute programs on several threads (with a multithread progress bar)

Parameters

[out]

vecVecProgramCall

: vector of commands to be exectuted (already split over threads)

Definition at line 72 of file phoenix_program_call.cpp.

                                                                                   {
        size_t nbThread = vecVecProgramCall.size();     //In case we need less thread than required
        PMultiThreadProgress progress(nbThread);
        std::vector<std::thread> vecThread;
        vecThread.resize(nbThread);
        std::thread threadProgress(phoenix_print_parallel_progress, std::ref(progress), 1);
        for(size_t i(0lu); i < nbThread; ++i){
                vecThread[i] = std::thread(phoenix_program_callVecProgress, std::ref(progress), std::ref(vecVecProgramCall[i]), i);
        }
        threadProgress.join();
        for(size_t i(0lu); i < nbThread; ++i){
                vecThread[i].join();
        }
        size_t nbSuccess(phoenix_program_getNbSuccessCall(vecVecProgramCall));
        size_t nbFail(phoenix_program_getNbCall(vecVecProgramCall) - nbSuccess);
        std::cout << "VecProgramCall : summary : " << nbSuccess << " success, " << nbFail << " fail" << std::endl;
}

References phoenix_print_parallel_progress(), phoenix_program_callVecProgress(), phoenix_program_getNbCall(), and phoenix_program_getNbSuccessCall().

Referenced by phoenix_program_callParallelProgressBar().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_program_callVec()

void phoenix_program_callVec

(

VecProgramCall &

vecCall

)

Call a vector of program.

Parameters

[out]

vecCall

: vector of program to be executed

Definition at line 41 of file phoenix_program_call.cpp.

                                                      {
        for(VecProgramCall::iterator it(vecCall.begin()); it != vecCall.end(); ++it){
                phoenix_program_call(*it);
        }
}

References phoenix_program_call().

Referenced by phoenix_program_callParallel().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_program_getNbCall()

size_t phoenix_program_getNbCall

(

const VecVecProgramCall &

vecCall

)

Get the number of call.

Parameters

vecCall

: vector of vector of call

Returns

number of call

Definition at line 166 of file phoenix_program_call.cpp.

                                                                   {
        size_t nbCall(0lu);
        for(VecVecProgramCall::const_iterator it(vecCall.begin()); it != vecCall.end(); ++it){
                nbCall += it->size();
        }
        return nbCall;
}

Referenced by phoenix_program_callParallelProgressBar().

Here is the caller graph for this function:

phoenix_program_getNbCallExitStatusType() [1/2]

size_t phoenix_program_getNbCallExitStatusType	(	const VecProgramCall &	vecCall,
		int	result )

Get number of call result of a given type.

Parameters

vecCall	: vector of call
result	: expected result

Returns

number of call with given result

Definition at line 125 of file phoenix_program_call.cpp.

                                                                                          {
        size_t nbSuccessCall(0lu);
        for(VecProgramCall::const_iterator it(vecCall.begin()); it != vecCall.end(); ++it){
                nbSuccessCall += it->getExitStatus() == result;
        }
        return nbSuccessCall;
}

Referenced by phoenix_program_getNbCallExitStatusType(), phoenix_program_getNbSuccessCall(), and phoenix_program_getNbSuccessCall().

Here is the caller graph for this function:

phoenix_program_getNbCallExitStatusType() [2/2]

size_t phoenix_program_getNbCallExitStatusType	(	const VecVecProgramCall &	vecCall,
		int	result )

Get number of call result of a given type.

Parameters

vecCall	: vector of vector of call
result	: expected result

Returns

number of call with given result

Definition at line 138 of file phoenix_program_call.cpp.

                                                                                             {
        size_t nbSuccessCall(0lu);
        for(VecVecProgramCall::const_iterator it(vecCall.begin()); it != vecCall.end(); ++it){
                nbSuccessCall += phoenix_program_getNbCallExitStatusType(*it, result);
        }
        return nbSuccessCall;
}

References phoenix_program_getNbCallExitStatusType().

Here is the call graph for this function:

phoenix_program_getNbSuccessCall() [1/2]

size_t phoenix_program_getNbSuccessCall

(

const VecProgramCall &

vecCall

)

Get the number of success call.

Parameters

vecCall

: vector of call

Returns

number of success call

Definition at line 150 of file phoenix_program_call.cpp.

                                                                       {
        return phoenix_program_getNbCallExitStatusType(vecCall, 0);
}

References phoenix_program_getNbCallExitStatusType().

Referenced by phoenix_program_callParallelProgressBar().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_program_getNbSuccessCall() [2/2]

size_t phoenix_program_getNbSuccessCall

(

const VecVecProgramCall &

vecCall

)

Get the number of success call.

Parameters

vecCall

: vector of vector of call

Returns

number of success call

Definition at line 158 of file phoenix_program_call.cpp.

                                                                          {
        return phoenix_program_getNbCallExitStatusType(vecCall, 0);
}

References phoenix_program_getNbCallExitStatusType().

Here is the call graph for this function: