vtkPVApplication Class Reference

Subclass of vtkKWApplication specific to the application. More...

#include <vtkPVApplication.h>

Inheritance diagram for vtkPVApplication:

[legend]Collaboration diagram for vtkPVApplication:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVApplication, vtkKWApplication)
void	PrintSelf (ostream &os, vtkIndent indent)
int	SetupRenderModule ()
virtual vtkKWLoadSaveDialog *	NewLoadSaveDialog ()
vtkMultiProcessController *	GetController ()
vtkSocketController *	GetSocketController ()
virtual int	RemoveWindow (vtkKWWindowBase *)
virtual int	Exit ()
virtual void	DestroyGUI ()
void	Initialize ()
void	DisplayHelpDialog (vtkKWWindowBase *master)
void	DisplayTCLError (const char *message)
ofstream *	GetTraceFile ()
virtual void	SetShowSourcesLongHelp (int)
virtual int	GetShowSourcesLongHelp ()
virtual void	ShowSourcesLongHelpOn ()
virtual void	ShowSourcesLongHelpOff ()
virtual void	SetSourcesBrowserAlwaysShowName (int)
virtual int	GetSourcesBrowserAlwaysShowName ()
virtual void	SourcesBrowserAlwaysShowNameOn ()
virtual void	SourcesBrowserAlwaysShowNameOff ()
virtual void	RestoreApplicationSettingsFromRegistry ()
void	ExecuteEvent (vtkObject *o, unsigned long event, void *calldata)
int	GetNumberOfPartitions ()
void	PlayDemo (int fromDashboard)
char *	GetTextRepresentation (vtkPVSource *comp)
void	SaveRuntimeInformation ()
int	SelfTest ()
int	ParseCommandLineArguments ()
virtual void	SetOptions (vtkPVGUIClientOptions *op)
virtual vtkSMApplication *	GetSMApplication ()
void	SetProcessModule (vtkPVProcessModule *module)
vtkPVProcessModule *	GetProcessModule ()
void	SetRenderModuleProxy (vtkSMRenderModuleProxy *)
virtual vtkSMRenderModuleProxy *	GetRenderModuleProxy ()
virtual void	Start (int argc, char *argv[])
virtual void	Start ()
int	AcceptLicense ()
int	AcceptEvaluation ()
void	StartRecordingScript (char *filename)
void	StopRecordingScript ()
vtkPVWindow *	GetMainWindow ()
vtkPVRenderView *	GetMainView ()
virtual void	SetStartGUI (int)
virtual int	GetStartGUI ()
virtual void	SetDisplay3DWidgets (int)
virtual void	Display3DWidgetsOn ()
virtual void	Display3DWidgetsOff ()
virtual int	GetDisplay3DWidgets ()
virtual void	SetNumberOfPipes (int)
virtual int	GetNumberOfPipes ()
virtual char *	GetArgv0 ()
virtual void	SetArgv0 (const char *)
virtual char *	GetTraceFileName ()
void	EnableTestErrors ()
void	DisableTestErrors ()
virtual int	SendStringToClient (const char *)
virtual int	SendStringToClientAndServer (const char *)
virtual int	SendStringToClientAndServerRoot (const char *)
virtual int	SendStringToServer (const char *)
virtual int	SendStringToServerRoot (const char *)
virtual const char *	GetStringFromServer ()
virtual const char *	GetStringFromClient ()
vtkPVGUIClientOptions *	GetGUIClientOptions ()
vtkPVOptions *	GetOptions ()
void	SetGarbageCollectionGlobalDebugFlag (int flag)
int	GetGarbageCollectionGlobalDebugFlag ()
void	DeferredGarbageCollectionPush ()
void	DeferredGarbageCollectionPop ()
Static Public Member Functions
vtkPVApplication *	New ()
void	Abort ()
Tcl_Interp *	InitializeTcl (int argc, char *argv[], ostream *err=0)
Static Public Attributes
const char *const	ExitProc
Protected Types
enum	{ NUM_ARGS = 100 }
Protected Member Functions
	vtkPVApplication ()
	~vtkPVApplication ()
virtual void	CreateSplashScreen ()
virtual void	ConfigureAboutDialog ()
virtual void	AddAboutText (ostream &)
void	CreateButtonPhotos ()
void	CreatePhoto (const char *name, const unsigned char *data, int width, int height, int pixel_size, unsigned long buffer_length=0, const char *filename=0)
int	CheckRegistration ()
int	PromptRegistration (char *, char *)
virtual void	FindInstallationDirectory ()
char *	CreateHelpString ()
int	CheckForTraceFile (char *name, unsigned int len)
void	DeleteTraceFiles (char *name, int all)
void	SaveTraceFile (const char *fname)
virtual void	SetTraceFileName (const char *)
virtual void	SetRenderModuleProxyName (const char *)
Static Protected Member Functions
int	CheckForExtension (const char *arg, const char *ext)
Protected Attributes
vtkKWPushButton *	SaveRuntimeInfoButton
vtkPVProcessModule *	ProcessModule
int	NumberOfPipes
int	Display3DWidgets
int	StartGUI
vtkPVOutputWindow *	OutputWindow
char *	TraceFileName
ofstream *	TraceFile
char *	Argv0
int	ShowSourcesLongHelp
int	SourcesBrowserAlwaysShowName
vtkPVApplicationObserver *	Observer
int	ApplicationInitialized
vtkSMApplication *	SMApplication
vtkPVGUIClientOptions *	Options
vtkSMRenderModuleProxy *	RenderModuleProxy
char *	RenderModuleProxyName
Static Protected Attributes
const char	ArgumentList [vtkPVApplication::NUM_ARGS][128]
vtkPVApplication *	MainApplication

---

Detailed Description

Subclass of vtkKWApplication specific to the application.

A subclass of vtkKWApplication specific to this application.

Definition at line 49 of file vtkPVApplication.h.

---

Member Enumeration Documentation

anonymous enum [protected]

Enumeration values: NUM_ARGS  Definition at line 357 of file vtkPVApplication.h.

---

Constructor & Destructor Documentation

vtkPVApplication::vtkPVApplication (   )  [protected]

vtkPVApplication::~vtkPVApplication (   )  [protected]

---

Member Function Documentation

vtkPVApplication* vtkPVApplication::New (   )  [static]

Reimplemented from vtkKWApplication.

vtkPVApplication::vtkTypeRevisionMacro (  vtkPVApplication  , vtkKWApplication  )

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

Reimplemented from vtkKWApplication.

int vtkPVApplication::ParseCommandLineArguments (   )

Parses the command line arguments and modifies the applications ivars appropriately. Return error (1) if the arguments are not formed properly. Returns 0 if all went well.

virtual void vtkPVApplication::SetOptions (  vtkPVGUIClientOptions *  op  )  [virtual]

Parses the command line arguments and modifies the applications ivars appropriately. Return error (1) if the arguments are not formed properly. Returns 0 if all went well.

virtual vtkSMApplication* vtkPVApplication::GetSMApplication (   )  [virtual]

Returns the server manager application.

void vtkPVApplication::SetProcessModule (  vtkPVProcessModule *  module  )

Process module contains all methods for managing processes and communication.

vtkPVProcessModule* vtkPVApplication::GetProcessModule (   )  [inline]

Process module contains all methods for managing processes and communication. Definition at line 73 of file vtkPVApplication.h.

void vtkPVApplication::SetRenderModuleProxy (  vtkSMRenderModuleProxy *   )

RenderModuleProxy manages rendering.

virtual vtkSMRenderModuleProxy* vtkPVApplication::GetRenderModuleProxy (   )  [virtual]

RenderModuleProxy manages rendering.

int vtkPVApplication::SetupRenderModule (   )

Setups the Render Module.

virtual vtkKWLoadSaveDialog* vtkPVApplication::NewLoadSaveDialog (   )  [virtual]

Get a file selection dialog instance.

virtual void vtkPVApplication::Start (  int  argc, char *  argv[] )  [virtual]

Start running the main application. Reimplemented from vtkKWApplication.

virtual void vtkPVApplication::Start (   )  [inline, virtual]

Start running the main application. Reimplemented from vtkKWApplication. Definition at line 92 of file vtkPVApplication.h. References vtkKWApplication::Start().

vtkMultiProcessController* vtkPVApplication::GetController (   )

We need to keep the controller in a prominent spot because there is no more "RegisterAndGetGlobalController" method. BTX

vtkSocketController* vtkPVApplication::GetSocketController (   )

If ParaView is running in client server mode, then this returns the socket controller used for client server communication. It will only be set on the client and process 0 of the server.

int vtkPVApplication::AcceptLicense (   )

No licence required.

int vtkPVApplication::AcceptEvaluation (   )

No licence required.

virtual int vtkPVApplication::RemoveWindow (  vtkKWWindowBase *   )  [virtual]

Add/Close a window to/of this application. Return 1 if successful, 0 otherwise Reimplemented from vtkKWApplication.

virtual int vtkPVApplication::Exit (   )  [virtual]

This method is invoked when the user exits the app Return 1 if the app exited successfully, 0 otherwise (for example, if some dialogs are still up, or the user did not confirm, etc). Reimplemented from vtkKWApplication.

virtual void vtkPVApplication::DestroyGUI (   )  [virtual]

Destroy the main window and associated objects without exiting. This simply calls superclass' Exit() but does not tell remote nodes to stop processing RMIs.

Tcl_Interp* vtkPVApplication::InitializeTcl (  int  argc, char *  argv[], ostream *  err = 0 )  [static]

Initialize Tcl/Tk Return NULL on error (eventually provides an ostream where detailed error messages will be stored). BTX Reimplemented from vtkKWApplication.

void vtkPVApplication::Initialize (   )

Perform internal PV Application initialization.

void vtkPVApplication::StartRecordingScript (  char *  filename  )

A start at recording macros in ParaView. Create a custom trace file that can be loaded back into paraview. Window variables get initialized when the file is opened. Note: The trace entries get diverted to this file. This is only used for testing at the moment. It is restricted to using sources created after the recording is started. The macro also cannot use the glyph sources. To make mocro recording available to the user, then there must be a way of setting arguments (existing sources) to the macro, and a way of prompting the user to set the arguments when the macro/script is loaded.

void vtkPVApplication::StopRecordingScript (   )

A start at recording macros in ParaView. Create a custom trace file that can be loaded back into paraview. Window variables get initialized when the file is opened. Note: The trace entries get diverted to this file. This is only used for testing at the moment. It is restricted to using sources created after the recording is started. The macro also cannot use the glyph sources. To make mocro recording available to the user, then there must be a way of setting arguments (existing sources) to the macro, and a way of prompting the user to set the arguments when the macro/script is loaded.

vtkPVWindow* vtkPVApplication::GetMainWindow (   )

Since ParaView has only one window, we might as well provide access to it.

vtkPVRenderView* vtkPVApplication::GetMainView (   )

Since ParaView has only one window, we might as well provide access to it.

void vtkPVApplication::DisplayHelpDialog (  vtkKWWindowBase *  master  )  [virtual]

Display the on-line help and about dialog for this application. Over-writing vtkKWApplication defaults. Reimplemented from vtkKWApplication.

virtual void vtkPVApplication::SetStartGUI (  int   )  [virtual]

Tells the process modules whether to start the main event loop. Mainly used by command line argument parsing code when an argument requires not starting the GUI

virtual int vtkPVApplication::GetStartGUI (   )  [virtual]

Tells the process modules whether to start the main event loop. Mainly used by command line argument parsing code when an argument requires not starting the GUI

void vtkPVApplication::DisplayTCLError (  const char *  message  )

virtual void vtkPVApplication::SetDisplay3DWidgets (  int   )  [virtual]

Set or get the display 3D widgets flag. When this flag is set, the 3D widgets will be displayed when they are created. Otherwise user has to enable them. User will still be able to disable the 3D widget.

virtual void vtkPVApplication::Display3DWidgetsOn (   )  [virtual]

Set or get the display 3D widgets flag. When this flag is set, the 3D widgets will be displayed when they are created. Otherwise user has to enable them. User will still be able to disable the 3D widget.

virtual void vtkPVApplication::Display3DWidgetsOff (   )  [virtual]

Set or get the display 3D widgets flag. When this flag is set, the 3D widgets will be displayed when they are created. Otherwise user has to enable them. User will still be able to disable the 3D widget.

virtual int vtkPVApplication::GetDisplay3DWidgets (   )  [virtual]

Set or get the display 3D widgets flag. When this flag is set, the 3D widgets will be displayed when they are created. Otherwise user has to enable them. User will still be able to disable the 3D widget.

virtual void vtkPVApplication::SetNumberOfPipes (  int   )  [virtual]

This is used internally for specifying how many pipes to use for rendering when UseRenderingGroup is defined. All processes have this set to the same value.

virtual int vtkPVApplication::GetNumberOfPipes (   )  [virtual]

This is used internally for specifying how many pipes to use for rendering when UseRenderingGroup is defined. All processes have this set to the same value.

virtual char* vtkPVApplication::GetArgv0 (   )  [virtual]

This is used (Unix only) to obtain the path of the executable. This path is used to locate demos etc.

virtual void vtkPVApplication::SetArgv0 (  const char *   )  [virtual]

This is used (Unix only) to obtain the path of the executable. This path is used to locate demos etc.

virtual char* vtkPVApplication::GetTraceFileName (   )  [virtual]

The name of the trace file.

ofstream* vtkPVApplication::GetTraceFile (   )  [inline]

This can be used to trace the application. Look at vtkKWWidgets to see how it is used. Definition at line 221 of file vtkPVApplication.h.

virtual void vtkPVApplication::SetShowSourcesLongHelp (  int   )  [virtual]

virtual int vtkPVApplication::GetShowSourcesLongHelp (   )  [virtual]

virtual void vtkPVApplication::ShowSourcesLongHelpOn (   )  [virtual]

virtual void vtkPVApplication::ShowSourcesLongHelpOff (   )  [virtual]

virtual void vtkPVApplication::SetSourcesBrowserAlwaysShowName (  int   )  [virtual]

virtual int vtkPVApplication::GetSourcesBrowserAlwaysShowName (   )  [virtual]

virtual void vtkPVApplication::SourcesBrowserAlwaysShowNameOn (   )  [virtual]

virtual void vtkPVApplication::SourcesBrowserAlwaysShowNameOff (   )  [virtual]

virtual void vtkPVApplication::RestoreApplicationSettingsFromRegistry (   )  [virtual]

Reimplemented from vtkKWApplication.

void vtkPVApplication::EnableTestErrors (   )

Enable or disable test errors. This refers to wether errors make test fail or not.

void vtkPVApplication::DisableTestErrors (   )

Enable or disable test errors. This refers to wether errors make test fail or not.

void vtkPVApplication::Abort (   )  [static]

Abort execution and display errors.

void vtkPVApplication::ExecuteEvent (  vtkObject *  o, unsigned long  event, void *  calldata )

Execute event on callback

int vtkPVApplication::GetNumberOfPartitions (   )

Get number of partitions.

void vtkPVApplication::PlayDemo (  int  fromDashboard  )

Play the demo

char* vtkPVApplication::GetTextRepresentation (  vtkPVSource *  comp  )

Return the textual representation of the composite (i.e. its name and/or its description. Memory is allocated, a pointer is return, it's up to the caller to delete it.

virtual int vtkPVApplication::SendStringToClient (  const char *   )  [virtual]

Send the stream represented by the given string to the client, server, or both. This should not be called by C++ code and is provided only for debugging and testing purposes. Returns 1 if the string is successfully parsed and 0 otherwise.

virtual int vtkPVApplication::SendStringToClientAndServer (  const char *   )  [virtual]

Send the stream represented by the given string to the client, server, or both. This should not be called by C++ code and is provided only for debugging and testing purposes. Returns 1 if the string is successfully parsed and 0 otherwise.

virtual int vtkPVApplication::SendStringToClientAndServerRoot (  const char *   )  [virtual]

Send the stream represented by the given string to the client, server, or both. This should not be called by C++ code and is provided only for debugging and testing purposes. Returns 1 if the string is successfully parsed and 0 otherwise.

virtual int vtkPVApplication::SendStringToServer (  const char *   )  [virtual]

Send the stream represented by the given string to the client, server, or both. This should not be called by C++ code and is provided only for debugging and testing purposes. Returns 1 if the string is successfully parsed and 0 otherwise.

virtual int vtkPVApplication::SendStringToServerRoot (  const char *   )  [virtual]

Send the stream represented by the given string to the client, server, or both. This should not be called by C++ code and is provided only for debugging and testing purposes. Returns 1 if the string is successfully parsed and 0 otherwise.

virtual const char* vtkPVApplication::GetStringFromServer (   )  [virtual]

Get a result stream represented by a string. This should not be called by C++ code and is provided only for debugging and testing purposes.

virtual const char* vtkPVApplication::GetStringFromClient (   )  [virtual]

Get a result stream represented by a string. This should not be called by C++ code and is provided only for debugging and testing purposes.

vtkPVGUIClientOptions* vtkPVApplication::GetGUIClientOptions (   )

Get application options.

vtkPVOptions* vtkPVApplication::GetOptions (   )

Get application options.

void vtkPVApplication::SetGarbageCollectionGlobalDebugFlag (  int  flag  )

Get/Set the global VTK garbage collection debugging flag. Methods provided here to allow use from test scripts.

int vtkPVApplication::GetGarbageCollectionGlobalDebugFlag (   )

Get/Set the global VTK garbage collection debugging flag. Methods provided here to allow use from test scripts.

void vtkPVApplication::DeferredGarbageCollectionPush (   )

Push/Pop deferred garbage collection.

void vtkPVApplication::DeferredGarbageCollectionPop (   )

Push/Pop deferred garbage collection.

void vtkPVApplication::SaveRuntimeInformation (   )

Save to a file the information available in the "About ParaView" dialog.

int vtkPVApplication::SelfTest (   )

Test some of the features that cannot be tested from the tcl.

virtual void vtkPVApplication::CreateSplashScreen (   )  [protected, virtual]

Reimplemented from vtkKWApplication.

virtual void vtkPVApplication::ConfigureAboutDialog (   )  [protected, virtual]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information. Reimplemented from vtkKWApplication.

virtual void vtkPVApplication::AddAboutText (  ostream &   )  [protected, virtual]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information. Reimplemented from vtkKWApplication.

void vtkPVApplication::CreateButtonPhotos (   )  [protected]

void vtkPVApplication::CreatePhoto (  const char *  name, const unsigned char *  data, int  width, int  height, int  pixel_size, unsigned long  buffer_length = 0, const char *  filename = 0 )  [protected]

int vtkPVApplication::CheckRegistration (   )  [protected]

int vtkPVApplication::PromptRegistration (  char *  , char *  )  [protected]

virtual void vtkPVApplication::FindInstallationDirectory (   )  [protected, virtual]

Reimplemented from vtkKWApplication.

int vtkPVApplication::CheckForExtension (  const char *  arg, const char *  ext )  [static, protected]

char* vtkPVApplication::CreateHelpString (   )  [protected]

int vtkPVApplication::CheckForTraceFile (  char *  name, unsigned int  len )  [protected]

void vtkPVApplication::DeleteTraceFiles (  char *  name, int  all )  [protected]

void vtkPVApplication::SaveTraceFile (  const char *  fname  )  [protected]

virtual void vtkPVApplication::SetTraceFileName (  const char *   )  [protected, virtual]

virtual void vtkPVApplication::SetRenderModuleProxyName (  const char *   )  [protected, virtual]

---

Member Data Documentation

const char* const vtkPVApplication::ExitProc [static]

Definition at line 185 of file vtkPVApplication.h.

vtkKWPushButton* vtkPVApplication::SaveRuntimeInfoButton [protected]

Definition at line 321 of file vtkPVApplication.h.

vtkPVProcessModule* vtkPVApplication::ProcessModule [protected]

Definition at line 334 of file vtkPVApplication.h.

int vtkPVApplication::NumberOfPipes [protected]

Definition at line 337 of file vtkPVApplication.h.

int vtkPVApplication::Display3DWidgets [protected]

Definition at line 339 of file vtkPVApplication.h.

int vtkPVApplication::StartGUI [protected]

Definition at line 341 of file vtkPVApplication.h.

vtkPVOutputWindow* vtkPVApplication::OutputWindow [protected]

Definition at line 343 of file vtkPVApplication.h.

char* vtkPVApplication::TraceFileName [protected]

Definition at line 352 of file vtkPVApplication.h.

ofstream* vtkPVApplication::TraceFile [protected]

Definition at line 353 of file vtkPVApplication.h.

char* vtkPVApplication::Argv0 [protected]

Definition at line 354 of file vtkPVApplication.h.

const char vtkPVApplication::ArgumentList[vtkPVApplication::NUM_ARGS][128] [static, protected]

Definition at line 361 of file vtkPVApplication.h.

vtkPVApplication* vtkPVApplication::MainApplication [static, protected]

Definition at line 364 of file vtkPVApplication.h.

int vtkPVApplication::ShowSourcesLongHelp [protected]

Definition at line 366 of file vtkPVApplication.h.

int vtkPVApplication::SourcesBrowserAlwaysShowName [protected]

Definition at line 367 of file vtkPVApplication.h.

vtkPVApplicationObserver* vtkPVApplication::Observer [protected]

Definition at line 369 of file vtkPVApplication.h.

int vtkPVApplication::ApplicationInitialized [protected]

Definition at line 371 of file vtkPVApplication.h.

vtkSMApplication* vtkPVApplication::SMApplication [protected]

Definition at line 373 of file vtkPVApplication.h.

vtkPVGUIClientOptions* vtkPVApplication::Options [protected]

Definition at line 375 of file vtkPVApplication.h.

vtkSMRenderModuleProxy* vtkPVApplication::RenderModuleProxy [protected]

Definition at line 377 of file vtkPVApplication.h.

char* vtkPVApplication::RenderModuleProxyName [protected]

Definition at line 378 of file vtkPVApplication.h.

---

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

• GUI/Client/vtkPVApplication.h

---