ParaView options storage. More...

#include <vtkCommandOptions.h>

Inheritance diagram for vtkCommandOptions:

Collaboration diagram for vtkCommandOptions:

Public Types
enum	{ EVERYBODY = 0, XMLONLY = 0x1 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	Parse (int argc, const char *const argv[])
void	GetRemainingArguments (int argc, char *argv[])
const char *	GetHelp ()
const char *	GetArgv0 ()
int	GetLastArgument ()
virtual int	ParseExtraXMLTag (const char , const char *)

virtual int	GetHelpSelected ()
virtual void	SetHelpSelected (int)

int	GetProcessType ()
void	SetProcessType (int p)

virtual char *	GetUnknownArgument ()

virtual char *	GetErrorMessage ()

virtual char *	GetApplicationPath ()
Static Public Member Functions
static vtkCommandOptions *	New ()
static int	IsTypeOf (const char *type)
static vtkCommandOptions *	SafeDownCast (vtkObject *o)
Protected Types

typedef int(*	CallbackType )(const char argument, const char value, void *call_data)
Protected Member Functions
	vtkCommandOptions ()
virtual	~vtkCommandOptions ()
void	AddCallback (const char longarg, const char shortarg, CallbackType callback, void call_data, const char help, int type=EVERYBODY)
virtual void	Initialize ()
virtual int	PostProcess (int argc, const char const argv)
virtual int	WrongArgument (const char *argument)
virtual int	DeprecatedArgument (const char *argument)
int	LoadXMLConfigFile (const char *)
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)
void	AddDeprecatedArgument (const char longarg, const char shortarg, const char *help, int type=EVERYBODY)
void	AddArgument (const char longarg, const char shortarg, int var, const char help, int type=EVERYBODY)
void	AddArgument (const char longarg, const char shortarg, char *var, const char help, int type=EVERYBODY)
Protected Attributes
vtkCommandOptionsXMLParser *	XMLParser

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.

Definition at line 32 of file vtkCommandOptions.h.

Member Typedef Documentation

typedef int(* vtkCommandOptions::CallbackType)(const char *argument, const char *value, void *call_data) [protected]

Prototype for callbacks.

Definition at line 101 of file vtkCommandOptions.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

EVERYBODY
XMLONLY

Definition at line 43 of file vtkCommandOptions.h.

Constructor & Destructor Documentation

vtkCommandOptions::vtkCommandOptions ( ) [protected]

Default constructor.

virtual vtkCommandOptions::~vtkCommandOptions ( ) [protected, virtual]

Destructor.

Member Function Documentation

static vtkCommandOptions* vtkCommandOptions::New ( ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkPVOptions, pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

virtual const char* vtkCommandOptions::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkPVOptions, pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

static int vtkCommandOptions::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkPVOptions, pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

virtual int vtkCommandOptions::IsA ( const char * type ) [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkPVOptions, pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

static vtkCommandOptions* vtkCommandOptions::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkPVOptions, pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

void vtkCommandOptions::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkObject.

Reimplemented in vtkPVOptions, pqOptions, vtkPVServerOptions, and vtkPVPythonOptions.

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

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

const char* vtkCommandOptions::GetHelp ( )

virtual int vtkCommandOptions::GetHelpSelected ( ) [virtual]

Was help selected?

virtual void vtkCommandOptions::SetHelpSelected ( int ) [virtual]

Was help selected?

int vtkCommandOptions::GetProcessType ( ) [inline]

Set/Get the type of the process for this set of options. data-server, render-server, combined-server or client.

Definition at line 61 of file vtkCommandOptions.h.

void vtkCommandOptions::SetProcessType ( int p ) [inline]

Set/Get the type of the process for this set of options. data-server, render-server, combined-server or client.

Definition at line 62 of file vtkCommandOptions.h.

virtual char* vtkCommandOptions::GetUnknownArgument ( ) [virtual]

In case of unknown argument, set this variable with the unknown argument.

virtual char* vtkCommandOptions::GetErrorMessage ( ) [virtual]

Get the error message if Parse returned 0.

const char* vtkCommandOptions::GetArgv0 ( )

Get argv[0]

virtual char* vtkCommandOptions::GetApplicationPath ( ) [virtual]

Get full path of executable (based on Argv0)

int vtkCommandOptions::GetLastArgument ( )

Get the index of the last argument parsed.

virtual int vtkCommandOptions::ParseExtraXMLTag	(	const char *	,
		const char **
	)		`[inline, virtual]`

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 89 of file vtkCommandOptions.h.

void vtkCommandOptions::AddBooleanArgument	(	const char *	longarg,
		const char *	shortarg,
		int *	var,
		const char *	help,
		int	type = `EVERYBODY`
	)		`[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.

void vtkCommandOptions::AddDeprecatedArgument	(	const char *	longarg,
		const char *	shortarg,
		const char *	help,
		int	type = `EVERYBODY`
	)		`[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.

void vtkCommandOptions::AddArgument	(	const char *	longarg,
		const char *	shortarg,
		int *	var,
		const char *	help,
		int	type = `EVERYBODY`
	)		`[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.

void vtkCommandOptions::AddArgument	(	const char *	longarg,
		const char *	shortarg,
		char **	var,
		const char *	help,
		int	type = `EVERYBODY`
	)		`[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.

void vtkCommandOptions::AddCallback	(	const char *	longarg,
		const char *	shortarg,
		CallbackType	callback,
		void *	call_data,
		const char *	help,
		int	type = `EVERYBODY`
	)		`[protected]`

virtual void vtkCommandOptions::Initialize ( ) [protected, virtual]

Initialize arguments.

Reimplemented in vtkPVOptions, pqOptions, and vtkPVServerOptions.

virtual int vtkCommandOptions::PostProcess	(	int	argc,
		const char const	argv
	)		`[protected, virtual]`

After parsing, process extra option dependencies.

Reimplemented in vtkPVOptions, pqOptions, and vtkPVPythonOptions.

virtual int vtkCommandOptions::WrongArgument ( const char * argument ) [protected, virtual]

This method is called when wrong argument is found. If it returns 0, then the parsing will fail.

Reimplemented in vtkPVOptions, pqOptions, and vtkPVPythonOptions.

virtual int vtkCommandOptions::DeprecatedArgument ( const char * argument ) [protected, virtual]

This method is called when a deprecated argument is found. If it returns 0, then the parsing will fail.

Reimplemented in vtkPVOptions.

int vtkCommandOptions::LoadXMLConfigFile ( const char * ) [protected]

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.

virtual void vtkCommandOptions::SetUnknownArgument ( const char * ) [protected, virtual]

virtual void vtkCommandOptions::SetErrorMessage ( const char * ) [protected, virtual]

virtual void vtkCommandOptions::SetXMLConfigFile ( const char * ) [protected, virtual]

void vtkCommandOptions::CleanArgcArgv ( ) [protected]

virtual void vtkCommandOptions::SetApplicationPath ( const char * ) [protected, virtual]

void vtkCommandOptions::ComputeApplicationPath ( ) [protected]

Member Data Documentation

vtkCommandOptionsXMLParser* vtkCommandOptions::XMLParser [protected]

Definition at line 160 of file vtkCommandOptions.h.

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

dox/ParaViewCore/Common/vtkCommandOptions.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation