VTK  9.0.20210809
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCommandLineProcess Class Reference

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

#include <vtkCommandLineProcess.h>

Inheritance diagram for vtkCommandLineProcess:
[legend]
Collaboration diagram for vtkCommandLineProcess:
[legend]

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. More...
 
vtkCommandLineProcessNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
 vtkCommandLineProcess ()
 
virtual ~vtkCommandLineProcess ()
 
void Execute ()
 Execute the command currently set if any. More...
 
virtual void SetTimeout (double)
 Set/Get command timeout in seconds. More...
 
virtual double GetTimeout ()
 
virtual void SetRightTrimResult (bool)
 Set/Get if we trim the ending whitespaces of the output. More...
 
virtual bool GetRightTrimResult ()
 
virtual void RightTrimResultOn ()
 
virtual void RightTrimResultOff ()
 
virtual char * GetCommand ()
 Set/Get command to execute. More...
 
virtual void SetCommand (const char *)
 
virtual char * GetStdOut ()
 Get output of the previously run command. More...
 
virtual char * GetStdErr ()
 
virtual int GetReturnValue ()
 Get return value of last command. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkCommandLineProcessNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCommandLineProcessSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void SetStdOut (const char *)
 
virtual void SetStdErr (const char *)
 
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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 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
 
- 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.

Definition at line 32 of file vtkCommandLineProcess.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkCommandLineProcess.h.

Constructor & Destructor Documentation

◆ vtkCommandLineProcess()

vtkCommandLineProcess::vtkCommandLineProcess ( )

◆ ~vtkCommandLineProcess()

virtual vtkCommandLineProcess::~vtkCommandLineProcess ( )
virtual

Member Function Documentation

◆ New()

static vtkCommandLineProcess* vtkCommandLineProcess::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCommandLineProcess::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 vtkCommandLineProcess* vtkCommandLineProcess::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCommandLineProcess::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCommandLineProcess* vtkCommandLineProcess::NewInstance ( ) const

◆ PrintSelf()

void vtkCommandLineProcess::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 vtkObject.

◆ Execute()

void vtkCommandLineProcess::Execute ( )

Execute the command currently set if any.

This will update the StdOut and StdErr properties.

◆ SetTimeout()

virtual void vtkCommandLineProcess::SetTimeout ( double  )
virtual

Set/Get command timeout in seconds.

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

Default is 5

◆ GetTimeout()

virtual double vtkCommandLineProcess::GetTimeout ( )
virtual

◆ SetRightTrimResult()

virtual void vtkCommandLineProcess::SetRightTrimResult ( bool  )
virtual

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

Default is true.

◆ GetRightTrimResult()

virtual bool vtkCommandLineProcess::GetRightTrimResult ( )
virtual

◆ RightTrimResultOn()

virtual void vtkCommandLineProcess::RightTrimResultOn ( )
virtual

◆ RightTrimResultOff()

virtual void vtkCommandLineProcess::RightTrimResultOff ( )
virtual

◆ GetCommand()

virtual char* vtkCommandLineProcess::GetCommand ( )
virtual

Set/Get command to execute.

An empty command will do nothing.

◆ SetCommand()

virtual void vtkCommandLineProcess::SetCommand ( const char *  )
virtual

◆ GetStdOut()

virtual char* vtkCommandLineProcess::GetStdOut ( )
virtual

Get output of the previously run command.

◆ GetStdErr()

virtual char* vtkCommandLineProcess::GetStdErr ( )
virtual

◆ GetReturnValue()

virtual int vtkCommandLineProcess::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 vtkCommandLineProcess::SetStdOut ( const char *  )
protectedvirtual

◆ SetStdErr()

virtual void vtkCommandLineProcess::SetStdErr ( const char *  )
protectedvirtual

◆ ExitProcess()

int vtkCommandLineProcess::ExitProcess ( vtksysProcess *  process)
protected

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