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

ParaView options storage. More...

#include <vtkPVOptionsXMLParser.h>

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

Public Types

typedef vtkCommandOptionsXMLParser Superclass
 
- Public Types inherited from vtkCommandOptionsXMLParser
typedef vtkXMLParser Superclass
 
- Public Types inherited from vtkXMLParser
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 vtkCommandOptionsXMLParser
void PrintSelf (ostream &os, vtkIndent indent) override
 
void AddBooleanArgument (const char *longarg, int *var, int type=0)
 Add arguments to the xml parser. More...
 
void AddArgument (const char *longarg, int *var, int type=0)
 Add arguments to the xml parser. More...
 
void AddArgument (const char *longarg, char **var, int type=0)
 Add arguments to the xml parser. More...
 
void SetPVOptions (vtkCommandOptions *o)
 Add arguments to the xml parser. More...
 
- Public Member Functions inherited from vtkXMLParser
vtkXMLParserNewInstance () const
 
virtual int Parse ()
 
virtual void SetStream (istream *)
 
virtual istream * GetStream ()
 
vtkTypeInt64 TellG ()
 
void SeekG (vtkTypeInt64 position)
 
virtual int Parse (const char *inputString)
 
virtual int Parse (const char *inputString, unsigned int length)
 
virtual int InitializeParser ()
 
virtual int ParseChunk (const char *inputString, unsigned int length)
 
virtual int CleanupParser ()
 
virtual void SetFileName (const char *)
 
virtual char * GetFileName ()
 
virtual void SetIgnoreCharacterData (int)
 
virtual int GetIgnoreCharacterData ()
 
virtual void SetEncoding (const char *)
 
virtual char * GetEncoding ()
 
virtual void SetStream (istream *)
 
virtual istream * GetStream ()
 
vtkTypeInt64 TellG ()
 
void SeekG (vtkTypeInt64 position)
 
virtual int Parse (const char *inputString)
 
virtual int Parse (const char *inputString, unsigned int length)
 
virtual int InitializeParser ()
 
virtual int ParseChunk (const char *inputString, unsigned int length)
 
virtual int CleanupParser ()
 
virtual void SetFileName (const char *)
 
virtual char * GetFileName ()
 
virtual void SetIgnoreCharacterData (int)
 
virtual int GetIgnoreCharacterData ()
 
virtual void SetEncoding (const char *)
 
virtual char * GetEncoding ()
 
- 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 vtkPVOptionsXMLParserNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVOptionsXMLParserSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCommandOptionsXMLParser
static vtkCommandOptionsXMLParserNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCommandOptionsXMLParserSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkXMLParser
static int IsTypeOf (const char *type)
 
static vtkXMLParserSafeDownCast (vtkObjectBase *o)
 
static vtkXMLParserNew ()
 
- 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

 vtkPVOptionsXMLParser ()=default
 
 ~vtkPVOptionsXMLParser () override=default
 
void SetProcessType (const char *ptype) override
 
- Protected Member Functions inherited from vtkCommandOptionsXMLParser
 vtkCommandOptionsXMLParser ()
 Default constructor. More...
 
 ~vtkCommandOptionsXMLParser () override
 Destructor. More...
 
void StartElement (const char *name, const char **atts) override
 
void EndElement (const char *name) override
 
void HandleOption (const char **atts)
 
void HandleProcessType (const char **atts)
 
void SetProcessTypeInt (int ptype)
 
- Protected Member Functions inherited from vtkXMLParser
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLParser ()
 
 ~vtkXMLParser ()
 
virtual int CreateParser ()
 
virtual int ParseXML ()
 
virtual int ParsingComplete ()
 
virtual void CharacterDataHandler (const char *data, int length)
 
virtual void ReportStrayAttribute (const char *element, const char *attr, const char *value)
 
virtual void ReportMissingAttribute (const char *element, const char *attr)
 
virtual void ReportBadAttribute (const char *element, const char *attr, const char *value)
 
virtual void ReportUnknownElement (const char *element)
 
virtual void ReportXmlParseError ()
 
vtkTypeInt64 GetXMLByteIndex ()
 
virtual int ParseBuffer (const char *buffer, unsigned int count)
 
int ParseBuffer (const char *buffer)
 
- 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

- Static Protected Member Functions inherited from vtkXMLParser
static int IsSpace (char c)
 
- Protected Attributes inherited from vtkXMLParser
istream * Stream
 
char * FileName
 
char * Encoding
 
int ParseError
 
const char * InputString
 
int InputStringLength
 
void * Parser
 
int IgnoreCharacterData
 
- 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 38 of file vtkPVOptionsXMLParser.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkPVOptionsXMLParser.h.

Constructor & Destructor Documentation

◆ vtkPVOptionsXMLParser()

vtkPVOptionsXMLParser::vtkPVOptionsXMLParser ( )
protecteddefault

◆ ~vtkPVOptionsXMLParser()

vtkPVOptionsXMLParser::~vtkPVOptionsXMLParser ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkPVOptionsXMLParser* vtkPVOptionsXMLParser::New ( )
static

◆ GetClassName()

virtual const char* vtkPVOptionsXMLParser::GetClassName ( )
virtual

Reimplemented from vtkCommandOptionsXMLParser.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkCommandOptionsXMLParser.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkXMLParser.

◆ SetProcessType()

void vtkPVOptionsXMLParser::SetProcessType ( const char *  ptype)
overrideprotectedvirtual

Reimplemented from vtkCommandOptionsXMLParser.


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