Aquisition]

The purpose of this class is to represent the Multibeam application. More...

#include <ssMultibeamApplication.h>

Inheritance diagram for ssMultibeamApplication:

[legend]Collaboration diagram for ssMultibeamApplication:


Public Member Functions
	vtkTypeMacro (ssMultibeamApplication, vtkKWApplication)
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the state of this object.
bool	ParseCommandLineArguments (int argc, char *argv[])
	Parse the command line arguments and set state.
void	SetProcessModule (ssMultibeamProcessModule *module)
	Specify the process module.
ssMultibeamProcessModule *	GetProcessModule ()
	Give the process module.
virtual void	Start (int argc, char *argv[])
	Start the application.
virtual void	Start ()
	Start the application.
virtual void	Start (char *arg)
	Start the application.
virtual int	Exit ()
	Shutdown gracefully.
ssMultibeamWindow *	MainWindow ()
	Give the main (i.e.
void	BroadcastScript (char *eventString,...)
	This function will cause the process leader (this object) to execute the script on the other processes.
void	BroadcastSimpleScript (const char *str)
	Broadcast a script for execution on all other processes.
ssMultibeamRenderModule *	RenderModule () const
	Give the render module in use.
vtkObject *	MakeTclObject (const char className, const char tclName)
	This constructs a Vtk object The user must cast to the correct type, and is responsible for deleting the object.
vtkObject *	TclToVTKObject (const char *tclName)
	This method returns pointer to the object specified as a tcl name.
Static Public Member Functions
static ssMultibeamApplication *	New ()
	Instantiate a new object of this type.
static Tcl_Interp *	InitializeTcl (int argc, char argv[], ostream err=0)
	Initialize the Tcl/Tk interpreter.
Protected Member Functions
	ssMultibeamApplication ()
	Ctor.
virtual	~ssMultibeamApplication ()
	Dtor.
void	RenderModule (ssMultibeamRenderModule *module)
	Specify the render module to use.
Protected Attributes
ssMultibeamProcessModule *	processModule
ssMultibeamAlertWindow *	alertWindow
ssMultibeamRenderModule *	renderModule
Static Protected Attributes
static const char *const	LoadComponentProc
static const char *const	ExitProc

Detailed Description

The purpose of this class is to represent the Multibeam application.

This is the lead class of the application.

Definition at line 22 of file ssMultibeamApplication.h.

Constructor & Destructor Documentation

ssMultibeamApplication::ssMultibeamApplication ( ) [protected]

Ctor.

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

Dtor.

Member Function Documentation

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

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:: The new object.

Reimplemented from vtkKWApplication.

ssMultibeamApplication::vtkTypeMacro	(	ssMultibeamApplication	,
		vtkKWApplication
	)

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

Print the state of this object.

Parameters:

	os	The output stream.
	indent	The indentation level. Used for formating output.

Reimplemented from vtkKWApplication.

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

Initialize the Tcl/Tk interpreter.

Must be done before any ssMultibeamApplication is instantiated.

Parameters:

	argc	The number of command line arguments - from main().
	argv	The command line argument vector - from main().
	err	This is the stream, returned from this function, to which stderr messages will be sent.

Returns:: If the initilization is sicessful then the Tcl Interpreter, zero otherwise.

Reimplemented from vtkKWApplication.

bool ssMultibeamApplication::ParseCommandLineArguments	(	int	argc,
		char *	argv[]
	)

Parse the command line arguments and set state.

Parameters:

	argc	Number of arguments (from main).
	argv	Argument vector (from main).

Returns:: If the parse failed in any way then true, false otherwise.

void ssMultibeamApplication::SetProcessModule ( ssMultibeamProcessModule * module )

Specify the process module.

Parameters:

module

The process module.

ssMultibeamProcessModule* ssMultibeamApplication::GetProcessModule ( )

Give the process module.

Returns:: The process module.

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

Start the application.

Parameters:

	argc	Number of arguments (from main).
	argv	Argument vector (from main).

Reimplemented from vtkKWApplication.

virtual void ssMultibeamApplication::Start ( ) [virtual]

Start the application.

Reimplemented from vtkKWApplication.

virtual void ssMultibeamApplication::Start ( char * arg ) [virtual]

Start the application.

Parameters:

arg

A single argument.

virtual int ssMultibeamApplication::Exit ( ) [virtual]

Shutdown gracefully.

Returns:: If the application exited succesfully then return 1. Otherwise return 0.

Reimplemented from vtkKWApplication.

ssMultibeamWindow* ssMultibeamApplication::MainWindow ( )

Give the main (i.e.

top level) window associated with this application.

Returns:: The top level.

void ssMultibeamApplication::BroadcastScript	(	char *	eventString,
			...
	)

This function will cause the process leader (this object) to execute the script on the other processes.

Can only be called by the process leader (i.e. process 0).

Parameters:

eventString

The script

void ssMultibeamApplication::BroadcastSimpleScript ( const char * str )

Broadcast a script for execution on all other processes.

Parameters:

str

The script.

ssMultibeamRenderModule* ssMultibeamApplication::RenderModule ( ) const

Give the render module in use.

Returns:: The module in use.

vtkObject* ssMultibeamApplication::MakeTclObject	(	const char *	className,
		const char *	tclName
	)

This constructs a Vtk object The user must cast to the correct type, and is responsible for deleting the object.

Parameters:

	className	The name of the Vtk class
	tclName	The instance name.

vtkObject* ssMultibeamApplication::TclToVTKObject ( const char * tclName )

This method returns pointer to the object specified as a tcl name.

Returns:: The object

void ssMultibeamApplication::RenderModule ( ssMultibeamRenderModule * module ) [protected]

Specify the render module to use.

Parameters:

module

The module

Member Data Documentation

ssMultibeamProcessModule* ssMultibeamApplication::processModule [protected]

Definition at line 166 of file ssMultibeamApplication.h.

ssMultibeamAlertWindow* ssMultibeamApplication::alertWindow [protected]

Definition at line 167 of file ssMultibeamApplication.h.

ssMultibeamRenderModule* ssMultibeamApplication::renderModule [protected]

Definition at line 168 of file ssMultibeamApplication.h.

const char* const ssMultibeamApplication::LoadComponentProc [static, protected]

Definition at line 171 of file ssMultibeamApplication.h.

const char* const ssMultibeamApplication::ExitProc [static, protected]

Definition at line 172 of file ssMultibeamApplication.h.

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

ssMultibeamApplication.h

ssMultibeamApplication Class Reference [Gui/Plan/Aquisition]

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

ssMultibeamApplication Class Reference
[Gui/Plan/Aquisition]