carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | List of all members
carputils.job.command.ShellCommand Class Reference

A command executable in the bash shell. More...

Inheritance diagram for carputils.job.command.ShellCommand:
carputils.job.command.Command carputils.job.command.MPICommand

Public Member Functions

def __init__ (self, command, message=None, skiperror=False, stdout=None, stderr=None)
 
def execute (self)
 Run this command right now. More...
 
def bash (self)
 Generate a bash statement executing this command. More...
 
- Public Member Functions inherited from carputils.job.command.Command
def execute (self)
 Run this command right now. More...
 
def bash (self)
 Generate a bash statement executing this command. More...
 

Detailed Description

A command executable in the bash shell.

Parameters

command list of str The command to execute in bash message str, optional A descriptive message to execute when running the command skiperror bool, optional When True, do not crash when the command fails in execute()

Constructor & Destructor Documentation

◆ __init__()

def carputils.job.command.ShellCommand.__init__ (   self,
  command,
  message = None,
  skiperror = False,
  stdout = None,
  stderr = None 
)

Member Function Documentation

◆ bash()

def carputils.job.command.ShellCommand.bash (   self)

Generate a bash statement executing this command.

◆ execute()

def carputils.job.command.ShellCommand.execute (   self)

Run this command right now.


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