vtkCommandOptions Class Reference

ParaView options storage. More...

#include <vtkCommandOptions.h>

Inheritance diagram for vtkCommandOptions:


Public Types
enum	{ EVERYBODY = 0, XMLONLY = 0x1 }
Public Member Functions
	vtkTypeRevisionMacro (vtkCommandOptions, vtkObject)
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 ()

int	GetProcessType ()
void	SetProcessType (int p)

virtual char *	GetUnknownArgument ()

virtual char *	GetErrorMessage ()
Static Public Member Functions
vtkCommandOptions *	New ()
Protected Member Functions
	vtkCommandOptions ()
virtual	~vtkCommandOptions ()
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 ()

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)

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

Member Enumeration Documentation

anonymous enum

Enumeration values:

EVERYBODY

XMLONLY

Definition at line 42 of file vtkCommandOptions.h.

Constructor & Destructor Documentation

vtkCommandOptions::vtkCommandOptions ( ) [protected]

Default constructor.

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

Destructor.

Member Function Documentation

vtkCommandOptions* vtkCommandOptions::New ( ) [static]

Reimplemented in vtkPVOptions, vtkPVServerOptions, vtkPVBatchOptions, and vtkPVGUIClientOptions.

vtkCommandOptions::vtkTypeRevisionMacro ( vtkCommandOptions ,

vtkObject

)

void vtkCommandOptions::PrintSelf ( ostream & os,

vtkIndent indent

)

Reimplemented in vtkPVOptions, vtkPVServerOptions, vtkPVBatchOptions, and vtkPVGUIClientOptions.

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?

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 56 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 57 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]

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 79 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.

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

Initialize arguments.
Reimplemented in vtkPVOptions, vtkPVServerOptions, vtkPVBatchOptions, and vtkPVGUIClientOptions.

virtual int vtkCommandOptions::PostProcess ( int argc,

const char *const * argv

) [protected, virtual]

After parsing, process extra option dependencies.
Reimplemented in vtkPVOptions, vtkPVBatchOptions, and vtkPVGUIClientOptions.

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, vtkPVBatchOptions, and vtkPVGUIClientOptions.

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]

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

Servers/Common/vtkCommandOptions.h

Generated on Tue May 30 12:36:41 2006 for ParaView by

1.3.5

vtkCommandOptions Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation