Call a program. More...

#include <ProgramCall.h>

Public Member Functions
PString &	getCommand ()
	Gets the command of the ProgramCall.

const PString &	getCommand () const
	Gets the command of the ProgramCall.

int &	getExitStatus ()
	Gets the exitStatus of the ProgramCall.

int	getExitStatus () const
	Gets the exitStatus of the ProgramCall.

PPath &	getLogFile ()
	Gets the logFile of the ProgramCall.

const PPath &	getLogFile () const
	Gets the logFile of the ProgramCall.

PString &	getName ()
	Gets the name of the ProgramCall.

const PString &	getName () const
	Gets the name of the ProgramCall.

PPath &	getWorkingDirectory ()
	Gets the workingDirectory of the ProgramCall.

const PPath &	getWorkingDirectory () const
	Gets the workingDirectory of the ProgramCall.

ProgramCall &	operator= (const ProgramCall &other)
	Operator = of class ProgramCall.

	ProgramCall ()
	Constructor of class ProgramCall.

	ProgramCall (const ProgramCall &other)
	Copy Constructor of class ProgramCall.

void	setCommand (const PString &command)
	Sets the command of the ProgramCall.

void	setExitStatus (int exitStatus)
	Sets the exitStatus of the ProgramCall.

void	setLogFile (const PPath &logFile)
	Sets the logFile of the ProgramCall.

void	setName (const PString &name)
	Sets the name of the ProgramCall.

void	setWorkingDirectory (const PPath &workingDirectory)
	Sets the workingDirectory of the ProgramCall.

virtual	~ProgramCall ()
	Destructor of class ProgramCall.

Protected Member Functions
void	copyProgramCall (const ProgramCall &other)
	Copy Function of class ProgramCall.

Private Member Functions
void	initialisationProgramCall ()
	Initialisation Function of class ProgramCall.

Private Attributes
PString	p_command
	Command to be executed.

int	p_exitStatus
	Exist status of the command.

PPath	p_logFile
	File where to put log of called program.

PString	p_name
	Name of the call.

PPath	p_workingDirectory
	Directory in which to execute the program.

Detailed Description

Call a program.

Definition at line 14 of file ProgramCall.h.

Constructor & Destructor Documentation

◆ ProgramCall() [1/2]

ProgramCall::ProgramCall ( )

Constructor of class ProgramCall.

Definition at line 13 of file ProgramCall.cpp.

                        {
        initialisationProgramCall();
}

References initialisationProgramCall().

Referenced by copyProgramCall(), operator=(), and ProgramCall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProgramCall() [2/2]

ProgramCall::ProgramCall ( const ProgramCall & other )

Copy Constructor of class ProgramCall.

Parameters

other : ProgramCall we want ot copy

Definition at line 20 of file ProgramCall.cpp.

                                                 {
        copyProgramCall(other);
}

References copyProgramCall(), and ProgramCall().

Here is the call graph for this function:

◆ ~ProgramCall()

ProgramCall::~ProgramCall ( )

virtual

Destructor of class ProgramCall.

Definition at line 25 of file ProgramCall.cpp.

                         {
        
}

Member Function Documentation

◆ copyProgramCall()

void ProgramCall::copyProgramCall ( const ProgramCall & other )

protected

Copy Function of class ProgramCall.

Parameters

other : ProgramCall we want ot copy

Definition at line 146 of file ProgramCall.cpp.

                                                          {
        p_name = other.p_name;
        p_command = other.p_command;
        p_workingDirectory = other.p_workingDirectory;
        p_exitStatus = other.p_exitStatus;
        p_logFile = other.p_logFile;
}

References p_command, p_exitStatus, p_logFile, p_name, p_workingDirectory, and ProgramCall().

Referenced by operator=(), and ProgramCall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommand() [1/2]

PString & ProgramCall::getCommand ( )

Gets the command of the ProgramCall.

Returns: command of the ProgramCall

Definition at line 97 of file ProgramCall.cpp.

                                 {
        return p_command;
}

References p_command.

◆ getCommand() [2/2]

const PString & ProgramCall::getCommand ( ) const

Gets the command of the ProgramCall.

Returns: command of the ProgramCall

Definition at line 90 of file ProgramCall.cpp.

                                             {
        return p_command;
}

References p_command.

Referenced by phoenix_program_call().

Here is the caller graph for this function:

◆ getExitStatus() [1/2]

int & ProgramCall::getExitStatus ( )

Gets the exitStatus of the ProgramCall.

Returns: exitStatus of the ProgramCall

Definition at line 125 of file ProgramCall.cpp.

                                {
        return p_exitStatus;
}

References p_exitStatus.

◆ getExitStatus() [2/2]

int ProgramCall::getExitStatus ( ) const

Gets the exitStatus of the ProgramCall.

Returns: exitStatus of the ProgramCall

Definition at line 118 of file ProgramCall.cpp.

                                    {
        return p_exitStatus;
}

References p_exitStatus.

◆ getLogFile() [1/2]

PPath & ProgramCall::getLogFile ( )

Gets the logFile of the ProgramCall.

Returns: logFile of the ProgramCall

Definition at line 139 of file ProgramCall.cpp.

                               {
        return p_logFile;
}

References p_logFile.

◆ getLogFile() [2/2]

const PPath & ProgramCall::getLogFile ( ) const

Gets the logFile of the ProgramCall.

Returns: logFile of the ProgramCall

Definition at line 132 of file ProgramCall.cpp.

                                           {
        return p_logFile;
}

References p_logFile.

Referenced by phoenix_program_call().

Here is the caller graph for this function:

◆ getName() [1/2]

PString & ProgramCall::getName ( )

Gets the name of the ProgramCall.

Returns: name of the ProgramCall

Definition at line 83 of file ProgramCall.cpp.

                              {
        return p_name;
}

References p_name.

◆ getName() [2/2]

const PString & ProgramCall::getName ( ) const

Gets the name of the ProgramCall.

Returns: name of the ProgramCall

Definition at line 76 of file ProgramCall.cpp.

                                          {
        return p_name;
}

References p_name.

◆ getWorkingDirectory() [1/2]

PPath & ProgramCall::getWorkingDirectory ( )

Gets the workingDirectory of the ProgramCall.

Returns: workingDirectory of the ProgramCall

Definition at line 111 of file ProgramCall.cpp.

                                        {
        return p_workingDirectory;
}

References p_workingDirectory.

◆ getWorkingDirectory() [2/2]

const PPath & ProgramCall::getWorkingDirectory ( ) const

Gets the workingDirectory of the ProgramCall.

Returns: workingDirectory of the ProgramCall

Definition at line 104 of file ProgramCall.cpp.

                                                    {
        return p_workingDirectory;
}

References p_workingDirectory.

Referenced by phoenix_program_call().

Here is the caller graph for this function:

◆ initialisationProgramCall()

void ProgramCall::initialisationProgramCall ( )

private

Initialisation Function of class ProgramCall.

Definition at line 155 of file ProgramCall.cpp.

                                           {
        p_name = "";
        p_command = "";
        p_workingDirectory = PPath();
        p_exitStatus = 0;
        p_logFile = PPath();
}

References p_command, p_exitStatus, p_logFile, p_name, and p_workingDirectory.

Referenced by ProgramCall().

Here is the caller graph for this function:

◆ operator=()

ProgramCall & ProgramCall::operator= ( const ProgramCall & other )

Operator = of class ProgramCall.

Parameters

other : ProgramCall we want ot copy

Returns: copied class ProgramCall

Definition at line 33 of file ProgramCall.cpp.

                                                               {
        copyProgramCall(other);
        return *this;
}

References copyProgramCall(), and ProgramCall().

Here is the call graph for this function:

◆ setCommand()

void ProgramCall::setCommand ( const PString & command )

Sets the command of the ProgramCall.

Parameters

command : command of the ProgramCall

Definition at line 48 of file ProgramCall.cpp.

                                                   {
        p_command = command;
}

References p_command.

Referenced by phoenix_program_addcall().

Here is the caller graph for this function:

◆ setExitStatus()

void ProgramCall::setExitStatus ( int exitStatus )

Sets the exitStatus of the ProgramCall.

Parameters

exitStatus : exitStatus of the ProgramCall

Definition at line 62 of file ProgramCall.cpp.

                                             {
        p_exitStatus = exitStatus;
}

References p_exitStatus.

Referenced by phoenix_program_addcall(), and phoenix_program_call().

Here is the caller graph for this function:

◆ setLogFile()

void ProgramCall::setLogFile ( const PPath & logFile )

Sets the logFile of the ProgramCall.

Parameters

logFile : logFile of the ProgramCall

Definition at line 69 of file ProgramCall.cpp.

                                                 {
        p_logFile = logFile;
}

References p_logFile.

Referenced by phoenix_program_addcall().

Here is the caller graph for this function:

◆ setName()

void ProgramCall::setName ( const PString & name )

Sets the name of the ProgramCall.

Parameters

name	: name of the ProgramCall

Definition at line 41 of file ProgramCall.cpp.

                                             {
        p_name = name;
}

References p_name.

Referenced by phoenix_program_addcall().

Here is the caller graph for this function:

◆ setWorkingDirectory()

void ProgramCall::setWorkingDirectory ( const PPath & workingDirectory )

Sets the workingDirectory of the ProgramCall.

Parameters

workingDirectory : workingDirectory of the ProgramCall

Definition at line 55 of file ProgramCall.cpp.

                                                                   {
        p_workingDirectory = workingDirectory;
}

References p_workingDirectory.

Referenced by phoenix_program_addcall().

Here is the caller graph for this function:

Member Data Documentation

◆ p_command

PString ProgramCall::p_command

private

Command to be executed.

Definition at line 42 of file ProgramCall.h.

Referenced by copyProgramCall(), getCommand(), getCommand(), initialisationProgramCall(), and setCommand().

◆ p_exitStatus

int ProgramCall::p_exitStatus

private

Exist status of the command.

Definition at line 46 of file ProgramCall.h.

Referenced by copyProgramCall(), getExitStatus(), getExitStatus(), initialisationProgramCall(), and setExitStatus().

◆ p_logFile

PPath ProgramCall::p_logFile

private

File where to put log of called program.

Definition at line 48 of file ProgramCall.h.

Referenced by copyProgramCall(), getLogFile(), getLogFile(), initialisationProgramCall(), and setLogFile().

◆ p_name

PString ProgramCall::p_name

private

Name of the call.

Definition at line 40 of file ProgramCall.h.

Referenced by copyProgramCall(), getName(), getName(), initialisationProgramCall(), and setName().

◆ p_workingDirectory

PPath ProgramCall::p_workingDirectory

private

Directory in which to execute the program.

Definition at line 44 of file ProgramCall.h.

Referenced by copyProgramCall(), getWorkingDirectory(), getWorkingDirectory(), initialisationProgramCall(), and setWorkingDirectory().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/system/PhoenixThread/src/ProgramCall.h
/builds/CTA-LAPP/PHOENIX_LIBS2/system/PhoenixThread/src/ProgramCall.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProgramCall() [1/2]

◆ ProgramCall() [2/2]

◆ ~ProgramCall()

Member Function Documentation

◆ copyProgramCall()

◆ getCommand() [1/2]

◆ getCommand() [2/2]

◆ getExitStatus() [1/2]

◆ getExitStatus() [2/2]

◆ getLogFile() [1/2]

◆ getLogFile() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getWorkingDirectory() [1/2]

◆ getWorkingDirectory() [2/2]

◆ initialisationProgramCall()

◆ operator=()

◆ setCommand()

◆ setExitStatus()

◆ setLogFile()

◆ setName()

◆ setWorkingDirectory()

Member Data Documentation

◆ p_command

◆ p_exitStatus

◆ p_logFile

◆ p_name

◆ p_workingDirectory