Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkProcessModuleConfiguration Class Reference

runtime configuration for vtkProcessModule More...

#include <vtkProcessModuleConfiguration.h>

Inheritance diagram for vtkProcessModuleConfiguration:
Inheritance graph
[legend]
Collaboration diagram for vtkProcessModuleConfiguration:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual bool GetForceMPIInit ()
 Get whether to call MPI_Init() on this process irrespective of whether MPI is needed on this process. More...
 
virtual bool GetForceNoMPIInit ()
 Get whether to not call MPI_Init() on this process irrespective of whether MPI is needed on this process. More...
 
virtual bool GetUseMPISSend ()
 Flag indicating whether to use synchronous send (SSend) for MPI communication. More...
 
virtual bool GetSymmetricMPIMode ()
 Get whether to use symmetric MPI mode. More...
 
virtual void SetSymmetricMPIMode (bool)
 Ideally, this method should not be public. More...
 
virtual vtkLogger::Verbosity GetLogStdErrVerbosity ()
 Get the verbosity level to use for reporting log messages on stderr. More...
 
std::string GetCSLogFileName () const
 Get the filename to use to generate client-server-stream logs, if any. More...
 
virtual bool GetEnableStackTrace ()
 Get whether to generate a stack trace after a crash. More...
 
const std::vector< std::pair< std::string, vtkLogger::Verbosity > > & GetLogFiles () const
 Returns a vector of pairs for log files requested. More...
 
bool PopulateOptions (vtkCLIOptions *options, vtkProcessModule::ProcessTypes processType)
 Populate command line options. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkProcessModuleConfigurationSafeDownCast (vtkObject *o)
 
static vtkProcessModuleConfigurationGetInstance ()
 Provides access to the singleton. More...
 
static std::string GetRankAnnotatedFileName (const std::string &fname)
 A helper function to add a rank number to the filename, if needed. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkProcessModuleConfiguration ()
 
 ~vtkProcessModuleConfiguration () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

runtime configuration for vtkProcessModule

vtkProcessModuleConfiguration is a singleton that maintains runtime configuration options that affect how vtkProcessModule is initialized.

Definition at line 36 of file vtkProcessModuleConfiguration.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkProcessModuleConfiguration.h.

Constructor & Destructor Documentation

◆ vtkProcessModuleConfiguration()

vtkProcessModuleConfiguration::vtkProcessModuleConfiguration ( )
protected

◆ ~vtkProcessModuleConfiguration()

vtkProcessModuleConfiguration::~vtkProcessModuleConfiguration ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkProcessModuleConfiguration::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkProcessModuleConfiguration::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkProcessModuleConfiguration::IsA ( const char *  type)
virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkProcessModuleConfiguration* vtkProcessModuleConfiguration::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkProcessModuleConfiguration::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ GetInstance()

static vtkProcessModuleConfiguration* vtkProcessModuleConfiguration::GetInstance ( )
static

Provides access to the singleton.

◆ GetForceMPIInit()

virtual bool vtkProcessModuleConfiguration::GetForceMPIInit ( )
virtual

Get whether to call MPI_Init() on this process irrespective of whether MPI is needed on this process.

◆ GetForceNoMPIInit()

virtual bool vtkProcessModuleConfiguration::GetForceNoMPIInit ( )
virtual

Get whether to not call MPI_Init() on this process irrespective of whether MPI is needed on this process.

◆ GetUseMPISSend()

virtual bool vtkProcessModuleConfiguration::GetUseMPISSend ( )
virtual

Flag indicating whether to use synchronous send (SSend) for MPI communication.

◆ GetSymmetricMPIMode()

virtual bool vtkProcessModuleConfiguration::GetSymmetricMPIMode ( )
virtual

Get whether to use symmetric MPI mode.

In this mode is only supported in "batch". In that case, all processes, including the satellites, execute the Python script locally.

◆ SetSymmetricMPIMode()

virtual void vtkProcessModuleConfiguration::SetSymmetricMPIMode ( bool  )
virtual

Ideally, this method should not be public.

However, we are keeping it public to avoid changing to much code at this time.

◆ GetLogStdErrVerbosity()

virtual vtkLogger::Verbosity vtkProcessModuleConfiguration::GetLogStdErrVerbosity ( )
virtual

Get the verbosity level to use for reporting log messages on stderr.

In other words, all messages at the chosen level and higher are posted to stderr. Default is vtkLogger::VERBOSITY_INVALID.

◆ GetCSLogFileName()

std::string vtkProcessModuleConfiguration::GetCSLogFileName ( ) const

Get the filename to use to generate client-server-stream logs, if any.

If running in a distributed mode, the filename is automatically changed to include current rank index.

◆ GetEnableStackTrace()

virtual bool vtkProcessModuleConfiguration::GetEnableStackTrace ( )
virtual

Get whether to generate a stack trace after a crash.

This is currently only supported on POSIX systems.

◆ GetLogFiles()

const std::vector<std::pair<std::string, vtkLogger::Verbosity> >& vtkProcessModuleConfiguration::GetLogFiles ( ) const
inline

Returns a vector of pairs for log files requested.

Definition at line 101 of file vtkProcessModuleConfiguration.h.

◆ PopulateOptions()

bool vtkProcessModuleConfiguration::PopulateOptions ( vtkCLIOptions options,
vtkProcessModule::ProcessTypes  processType 
)

Populate command line options.

processType indicates which type of ParaView process the options are being setup for. That may affect available options.

◆ GetRankAnnotatedFileName()

static std::string vtkProcessModuleConfiguration::GetRankAnnotatedFileName ( const std::string fname)
static

A helper function to add a rank number to the filename, if needed.

This is useful to create a separate log file per rank, for example, when executing in parallel. If number of ranks is 1, the filename is unchanged.


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