ParaView options storage. More...
#include <vtkCommandOptions.h>
Public Types | |
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 |
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 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 Types | |
typedef int(* | CallbackType) (const char *argument, const char *value, void *call_data) |
Prototype for callbacks. More... | |
Protected Member Functions | |
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 &) |
Protected Attributes | |
vtkCommandOptionsXMLParser * | XMLParser |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 34 of file vtkCommandOptions.h.
Definition at line 38 of file vtkCommandOptions.h.
|
protected |
Prototype for callbacks.
Definition at line 118 of file vtkCommandOptions.h.
anonymous enum |
Enumerator | |
---|---|
EVERYBODY | |
XMLONLY |
Definition at line 44 of file vtkCommandOptions.h.
|
protected |
Default constructor.
|
overrideprotected |
Destructor.
|
static |
|
virtual |
Reimplemented in pqOptions, vtkPVOptions, vtkPVServerOptions, and vtkPVPythonOptions.
Reimplemented from vtkObjectBase.
Reimplemented in pqOptions, vtkPVOptions, vtkPVServerOptions, and vtkPVPythonOptions.
|
static |
|
overridevirtual |
Reimplemented from vtkObject.
void vtkCommandOptions::GetRemainingArguments | ( | int * | argc, |
char ** | argv[] | ||
) |
const char* vtkCommandOptions::GetHelp | ( | ) |
|
virtual |
Was help selected?
|
virtual |
Was help selected?
|
inline |
Set/Get the type of the process for this set of options.
data-server, render-server, combined-server or client.
Definition at line 64 of file vtkCommandOptions.h.
|
inline |
Definition at line 65 of file vtkCommandOptions.h.
|
virtual |
In case of unknown argument, set this variable with the unknown argument.
|
virtual |
Get the error message if Parse returned 0.
const char* vtkCommandOptions::GetArgv0 | ( | ) |
Get argv[0].
|
virtual |
Get full path of executable (based on Argv0)
int vtkCommandOptions::GetLastArgument | ( | ) |
Get the index of the last argument parsed.
Pass in the name and the attributes for all tags that are not Options.
If it returns 1, then it is successful, and 0 if it failed.
Reimplemented in vtkPVServerOptions.
Definition at line 102 of file vtkCommandOptions.h.
|
protected |
Add a command line option.
For each argument added there is a long version –long and a short version -l, a help string, and a variable that is set to the value of the option. The types can be int, char*, or boolean (set to 1 of option is present). Also deprecated arguments can be added with only a help string. The help string should say that the argument is deprecated and suggest the alternative argument to use. Each option can specify in a bit flag int the processes that the option is valid for, the default is to be valid for all paraview processes.
|
protected |
Add a command line option.
For each argument added there is a long version –long and a short version -l, a help string, and a variable that is set to the value of the option. The types can be int, char*, or boolean (set to 1 of option is present). Also deprecated arguments can be added with only a help string. The help string should say that the argument is deprecated and suggest the alternative argument to use. Each option can specify in a bit flag int the processes that the option is valid for, the default is to be valid for all paraview processes.
|
protected |
Add a command line option.
For each argument added there is a long version –long and a short version -l, a help string, and a variable that is set to the value of the option. The types can be int, char*, or boolean (set to 1 of option is present). Also deprecated arguments can be added with only a help string. The help string should say that the argument is deprecated and suggest the alternative argument to use. Each option can specify in a bit flag int the processes that the option is valid for, the default is to be valid for all paraview processes.
|
protected |
Add a command line option.
For each argument added there is a long version –long and a short version -l, a help string, and a variable that is set to the value of the option. The types can be int, char*, or boolean (set to 1 of option is present). Also deprecated arguments can be added with only a help string. The help string should say that the argument is deprecated and suggest the alternative argument to use. Each option can specify in a bit flag int the processes that the option is valid for, the default is to be valid for all paraview processes.
|
protected |
|
protectedvirtual |
Initialize arguments.
Reimplemented in vtkPVOptions, pqOptions, and vtkPVServerOptions.
After parsing, process extra option dependencies.
Reimplemented in vtkPVOptions, and pqOptions.
This method is called when wrong argument is found.
If it returns 0, then the parsing will fail.
Reimplemented in vtkPVOptions, pqOptions, and vtkPVPythonOptions.
This method is called when a deprecated argument is found.
If it returns 0, then the parsing will fail.
Reimplemented in vtkPVOptions.
This method loads the paraview config file.
The command line will override any of the values in this file, but all options can be in the file.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protected |
|
protectedvirtual |
|
protected |
|
protected |
Definition at line 185 of file vtkCommandOptions.h.