vtkExecutableRunner Class Reference

Launch a process on the current machine and get its output. More...

#include <vtkExecutableRunner.h>

Inheritance diagram for vtkExecutableRunner:

Collaboration diagram for vtkExecutableRunner:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkExecutableRunner *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
	vtkExecutableRunner ()=default
	~vtkExecutableRunner () override=default
void	Execute ()
	Execute the command currently set if any.
virtual int	GetReturnValue ()
	Get return value of last command.
virtual void	SetTimeout (double)
	Set/Get command timeout in seconds.
virtual double	GetTimeout ()
	Set/Get command timeout in seconds.
virtual void	SetRightTrimResult (bool)
	Set/Get if we trim the ending whitespaces of the output.
virtual bool	GetRightTrimResult ()
	Set/Get if we trim the ending whitespaces of the output.
virtual void	RightTrimResultOn ()
	Set/Get if we trim the ending whitespaces of the output.
virtual void	RightTrimResultOff ()
	Set/Get if we trim the ending whitespaces of the output.
	vtkGetCharFromStdStringMacro (Command)
	Set/Get command to execute.
	vtkSetStdStringFromCharMacro (Command)
	Set/Get command to execute.
virtual void	SetExecuteInSystemShell (bool)
	Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).
virtual bool	GetExecuteInSystemShell ()
	Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).
virtual void	ExecuteInSystemShellOn ()
	Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).
virtual void	ExecuteInSystemShellOff ()
	Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).
virtual void	AddArgument (const std::string &arg)
	API to control arguments passed to the command when ExecuteInSystemShell is false.
virtual void	ClearArguments ()
	API to control arguments passed to the command when ExecuteInSystemShell is false.
virtual vtkIdType	GetNumberOfArguments () const
	API to control arguments passed to the command when ExecuteInSystemShell is false.
	vtkGetCharFromStdStringMacro (StdOut)
	Get output of the previously run command.
	vtkGetCharFromStdStringMacro (StdErr)
	Get output of the previously run command.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkExecutableRunner *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkExecutableRunner *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
virtual void	SetStdOut (std::string)
virtual void	SetStdErr (std::string)
std::vector< std::string >	GetCommandToExecute () const
int	ExitProcess (vtksysProcess *process)
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Launch a process on the current machine and get its output.

Launch a process on the current machine and get its standard output and standard error output. When ExecuteInSystemShell is false, arguments needs to be added separately using the AddArgument / ClearArguments API, otherwise command may not work correctly. If one does not know how to parse the arguments of the command it want to execute then ExecuteInSystemShell should be set to true.

Tests:

vtkExecutableRunner (Tests)

Definition at line 29 of file vtkExecutableRunner.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkExecutableRunner::Superclass

Definition at line 33 of file vtkExecutableRunner.h.

Constructor & Destructor Documentation

vtkExecutableRunner()

vtkExecutableRunner::vtkExecutableRunner ( )

default

~vtkExecutableRunner()

vtkExecutableRunner::~vtkExecutableRunner ( )

overridedefault

Member Function Documentation

New()

static vtkExecutableRunner * vtkExecutableRunner::New ( )

static

IsTypeOf()

static vtkTypeBool vtkExecutableRunner::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkExecutableRunner::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

SafeDownCast()

static vtkExecutableRunner * vtkExecutableRunner::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkExecutableRunner::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkExecutableRunner * vtkExecutableRunner::NewInstance

(

)

const

PrintSelf()

void vtkExecutableRunner::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

Execute()

void vtkExecutableRunner::Execute

(

)

Execute the command currently set if any.

This will update the StdOut and StdErr properties.

SetTimeout()

virtual void vtkExecutableRunner::SetTimeout ( double  )

virtual

Set/Get command timeout in seconds.

A non-positive (<= 0) value will disable the timeout.

Default is 5

GetTimeout()

virtual double vtkExecutableRunner::GetTimeout ( )

virtual

Set/Get command timeout in seconds.

A non-positive (<= 0) value will disable the timeout.

Default is 5

SetRightTrimResult()

virtual void vtkExecutableRunner::SetRightTrimResult ( bool  )

virtual

Set/Get if we trim the ending whitespaces of the output.

Default is true.

GetRightTrimResult()

virtual bool vtkExecutableRunner::GetRightTrimResult ( )

virtual

Set/Get if we trim the ending whitespaces of the output.

Default is true.

RightTrimResultOn()

virtual void vtkExecutableRunner::RightTrimResultOn ( )

virtual

Set/Get if we trim the ending whitespaces of the output.

Default is true.

RightTrimResultOff()

virtual void vtkExecutableRunner::RightTrimResultOff ( )

virtual

Set/Get if we trim the ending whitespaces of the output.

Default is true.

vtkGetCharFromStdStringMacro() [1/3]

vtkExecutableRunner::vtkGetCharFromStdStringMacro

(

Command

)

Set/Get command to execute.

An empty command will do nothing.

vtkSetStdStringFromCharMacro()

vtkExecutableRunner::vtkSetStdStringFromCharMacro

(

Command

)

Set/Get command to execute.

An empty command will do nothing.

SetExecuteInSystemShell()

virtual void vtkExecutableRunner::SetExecuteInSystemShell ( bool  )

virtual

Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).

This is handy when the user doesn't know how to split arguments from a single string.

Default to true.

GetExecuteInSystemShell()

virtual bool vtkExecutableRunner::GetExecuteInSystemShell ( )

virtual

Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).

This is handy when the user doesn't know how to split arguments from a single string.

Default to true.

ExecuteInSystemShellOn()

virtual void vtkExecutableRunner::ExecuteInSystemShellOn ( )

virtual

Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).

This is handy when the user doesn't know how to split arguments from a single string.

Default to true.

ExecuteInSystemShellOff()

virtual void vtkExecutableRunner::ExecuteInSystemShellOff ( )

virtual

Allows the command to be launched using the system shell (sh on unix systems, cmd.exe on windows).

This is handy when the user doesn't know how to split arguments from a single string.

Default to true.

AddArgument()

virtual void vtkExecutableRunner::AddArgument ( const std::string &  arg )

virtual

API to control arguments passed to the command when ExecuteInSystemShell is false.

Default is no argument.

ClearArguments()

virtual void vtkExecutableRunner::ClearArguments ( )

virtual

API to control arguments passed to the command when ExecuteInSystemShell is false.

Default is no argument.

GetNumberOfArguments()

virtual vtkIdType vtkExecutableRunner::GetNumberOfArguments ( ) const

virtual

API to control arguments passed to the command when ExecuteInSystemShell is false.

Default is no argument.

vtkGetCharFromStdStringMacro() [2/3]

vtkExecutableRunner::vtkGetCharFromStdStringMacro

(

StdOut

)

Get output of the previously run command.

vtkGetCharFromStdStringMacro() [3/3]

vtkExecutableRunner::vtkGetCharFromStdStringMacro

(

StdErr

)

Get output of the previously run command.

GetReturnValue()

virtual int vtkExecutableRunner::GetReturnValue ( )

virtual

Get return value of last command.

If no command has been executed or if the command has failed in some way value is != 0, else return 0.

SetStdOut()

virtual void vtkExecutableRunner::SetStdOut ( std::string  )

protectedvirtual

SetStdErr()

virtual void vtkExecutableRunner::SetStdErr ( std::string  )

protectedvirtual

GetCommandToExecute()

std::vector< std::string > vtkExecutableRunner::GetCommandToExecute ( ) const

protected

ExitProcess()

int vtkExecutableRunner::ExitProcess ( vtksysProcess *  process )

protected

---

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

• Common/System/vtkExecutableRunner.h