ParaView options storage. More...

#include <vtkPVOptions.h>

Inheritance diagram for vtkPVOptions:

Collaboration diagram for vtkPVOptions:

[legend]

Public Types
enum	ProcessTypeEnum { PARAVIEW = 0x2, PVCLIENT = 0x4, PVSERVER = 0x8, PVRENDER_SERVER = 0x10, PVDATA_SERVER = 0x20, PVBATCH = 0x40, ALLPROCESS = PARAVIEW \| PVCLIENT \| PVSERVER \| PVRENDER_SERVER \| PVDATA_SERVER \| PVBATCH }
	Returns the verbosity level for stderr output chosen. More...

typedef vtkCommandOptions	Superclass

Public Types inherited from vtkCommandOptions
enum	{ EVERYBODY = 0, XMLONLY = 0x1 }

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

Public Member Functions inherited from vtkCommandOptions
void	PrintSelf (ostream &os, vtkIndent indent) override

int	Parse (int argc, const char *const argv[])

void	GetRemainingArguments (int argc, char *argv[])

const char *	GetHelp ()

int	GetProcessType ()
	Set/Get the type of the process for this set of options. More...

void	SetProcessType (int p)

const char *	GetArgv0 ()
	Get argv[0]. More...

int	GetLastArgument ()
	Get the index of the last argument parsed. More...

virtual int	ParseExtraXMLTag (const char , const char *)
	Pass in the name and the attributes for all tags that are not Options. More...

virtual int	GetHelpSelected ()
	Was help selected? More...

virtual void	SetHelpSelected (int)
	Was help selected? More...

virtual char *	GetUnknownArgument ()
	In case of unknown argument, set this variable with the unknown argument. More...

virtual char *	GetErrorMessage ()
	Get the error message if Parse returned 0. More...

virtual char *	GetApplicationPath ()
	Get full path of executable (based on Argv0) 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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkPVOptions *	New ()

static int	IsTypeOf (const char *type)

static vtkPVOptions *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkCommandOptions
static vtkCommandOptions *	New ()

static int	IsTypeOf (const char *type)

static vtkCommandOptions *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVOptions ()

	~vtkPVOptions () override

Protected Member Functions inherited from vtkCommandOptions
	vtkCommandOptions ()
	Default constructor. More...

	~vtkCommandOptions () override
	Destructor. More...

void	AddCallback (const char longarg, const char shortarg, CallbackType callback, void call_data, const char help, int type=EVERYBODY)

virtual void	Initialize ()
	Initialize arguments. More...

virtual int	PostProcess (int argc, const char const argv)
	After parsing, process extra option dependencies. More...

virtual int	WrongArgument (const char *argument)
	This method is called when wrong argument is found. More...

virtual int	DeprecatedArgument (const char *argument)
	This method is called when a deprecated argument is found. More...

int	LoadXMLConfigFile (const char *)
	This method loads the paraview config file. More...

virtual void	SetUnknownArgument (const char *)

virtual void	SetErrorMessage (const char *)

virtual void	SetXMLConfigFile (const char *)

void	CleanArgcArgv ()

virtual void	SetApplicationPath (const char *)

void	ComputeApplicationPath ()

void	AddBooleanArgument (const char longarg, const char shortarg, int var, const char help, int type=EVERYBODY)
	Add a command line option. More...

void	AddDeprecatedArgument (const char longarg, const char shortarg, const char *help, int type=EVERYBODY)
	Add a command line option. More...

void	AddArgument (const char longarg, const char shortarg, int var, const char help, int type=EVERYBODY)
	Add a command line option. More...

void	AddArgument (const char longarg, const char shortarg, char *var, const char help, int type=EVERYBODY)
	Add a command line option. More...

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 &)

Friends
class	vtkPVOptionsXMLParser

Additional Inherited Members
Protected Types inherited from vtkCommandOptions
typedef int(*	CallbackType) (const char argument, const char value, void *call_data)
	Prototype for callbacks. More...

Protected Attributes inherited from vtkCommandOptions
vtkCommandOptionsXMLParser *	XMLParser

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

ParaView options storage.

An object of this class represents a storage for ParaView options

These options can be retrieved during run-time, set using configuration file or using Command Line Arguments.

Deprecated:: in ParaView 5.12.0. See vtkCLIOptions instead. See https://gitlab.kitware.com/paraview/paraview/-/merge_requests/4951 for developer guidelines.

Definition at line 30 of file vtkPVOptions.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCommandOptions vtkPVOptions::Superclass

Definition at line 38 of file vtkPVOptions.h.

Member Enumeration Documentation

◆ ProcessTypeEnum

enum vtkPVOptions::ProcessTypeEnum

Returns the verbosity level for stderr output chosen.

Is set to vtkLogger::VERBOSITY_INVALID if not specified.

Enumerator
PARAVIEW
PVCLIENT
PVSERVER
PVRENDER_SERVER
PVDATA_SERVER
PVBATCH
ALLPROCESS

Definition at line 48 of file vtkPVOptions.h.

Constructor & Destructor Documentation

◆ vtkPVOptions()

vtkPVOptions::vtkPVOptions ( )

protected

◆ ~vtkPVOptions()

vtkPVOptions::~vtkPVOptions ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVOptions* vtkPVOptions::New ( )

static

◆ GetClassName()

virtual const char* vtkPVOptions::GetClassName ( )

virtual

Reimplemented from vtkCommandOptions.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkCommandOptions.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Friends And Related Function Documentation

◆ vtkPVOptionsXMLParser

friend class vtkPVOptionsXMLParser

friend

Definition at line 33 of file vtkPVOptions.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVOptions.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ProcessTypeEnum

Constructor & Destructor Documentation

◆ vtkPVOptions()

◆ ~vtkPVOptions()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

Friends And Related Function Documentation

◆ vtkPVOptionsXMLParser