ssMultibeamLWApplication Class Reference
[Gui/Plan/Aquisition]

This is a lightweight edition of the Multibeam Application. More...

#include <ssMultibeamLWApplication.h>

Inheritance diagram for ssMultibeamLWApplication:

Inheritance graph
[legend]
Collaboration diagram for ssMultibeamLWApplication:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (ssMultibeamLWApplication, vtkKWApplication)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the state of this object.
vtkObjectMakeTclObject (const char *type, const char *name)
 Instantiate a Tcl object.
vtkObjectTclToVTKObject (const char *name)
 Give a reference to a Tcl object.
ssMultibeamLWWindowWindow () const
 Give the GUI.
void GuiProcess (Tcl_Interp *interp, vtkMultiProcessController *controller, int argc, char *argv[])
 Start the Gui portion of the object.
void SdfProcess (Tcl_Interp *interp, vtkMultiProcessController *controller)
 Start the SDF portion of the object.
vtkMultiProcessControllerGuiProcess () const
 Give this object's Gui process controller.
vtkMultiProcessControllerSdfProcess () const
 Give this object's Sdf process controller.
virtual int Exit ()
 Called on exit.
void GUIProcess ()
 Start the GUI thread.

Static Public Member Functions

static ssMultibeamLWApplicationNew ()
 Instantiate a new object of this type.

Protected Member Functions

 ssMultibeamLWApplication ()
 Ctor.
 ~ssMultibeamLWApplication ()
 Dtor.

Protected Attributes

vtkMultiProcessControllerguiController
 The Gui process controller.
vtkMultiProcessControllersdfController
 The SDF process controller.
vtkSocketCommunicatornavPort
 The navigation input port.
vtkSocketCommunicatorbathyPort
 The bathymetry input port.
vtkSocketCommunicatorattitudePort
 The attitude input port.
vtkSocketCommunicatortidePort
 The tide input port.
vtkSocketCommunicatorvelocimeterPort
 The velocimeter input port.
vtkSocketCommunicatortempPort
 The temperature input port.
ssPolyDatatoPlanStaticFilterplanFilter
 The filter that is responsible for scrolling the plan view.
ssPolyDatatoBathymetryScrollFilterswathFilter
 The filter that is responsible for scrolling the swath bathymetry view.
ssPolyDatatoAttitudeScrollFilterrollFilter
 The filter that is responsible for scrolling the roll view.
ssPolyDatatoAttitudeScrollFilterpitchFilter
 The filter that is responsible for scrolling the pitch view.

Friends

void ssMultibeamLWApplication_NavigationDAVRMI (void *localArg, void *, int, int remoteProcessId)
 The navigation data RMI.
void ssMultibeamLWApplication_BathymetryDAVRMI (void *localArg, void *, int, int remoteProcessId)
 The bathymetry data RMI.
void ssMultibeamLWApplication_AttitudeDAVRMI (void *localArg, void *, int, int remoteProcessId)
 The attitude data RMI.
void ssMultibeamLWApplication_TideDAVRMI (void *localArg, void *, int, int remoteProcessId)
 The tide data RMI.
void ssMultibeamLWApplication_VelocimeterDAVRMI (void *localArg, void *, int, int remoteProcessId)
 The Velocimeter data RMI.
void ssMultibeamLWApplication_TemperatureDAVRMI (void *localArg, void *, int, int remoteProcessId)
 The temperature data RMI.
void GUIProcess (vtkMultiProcessController *tlc, void *userdata)
void SDFProcess (vtkMultiProcessController *tlc, void *userdata)

Detailed Description

This is a lightweight edition of the Multibeam Application.

Manages the application as a whole.

Only one object of this type may exist on the system at a time. This obect is a singleton.

Definition at line 40 of file ssMultibeamLWApplication.h.


Constructor & Destructor Documentation

ssMultibeamLWApplication::ssMultibeamLWApplication (  )  [protected]

Ctor.

ssMultibeamLWApplication::~ssMultibeamLWApplication (  )  [protected]

Dtor.


Member Function Documentation

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

Instantiate a new object of this type.

This is the only method that objects of this type may be created. The object returned is a singleton. I.e. if there is no object of this type in existance create one. Otherwise just give the existing one. In any case the reference count of the singleton object is incremented by this call and, therefore, a call to this object's Delete() is required before the reference goes out of scope.

Returns:
The singleton object.

Reimplemented from vtkKWApplication.

ssMultibeamLWApplication::vtkTypeMacro ( ssMultibeamLWApplication  ,
vtkKWApplication   
)

void ssMultibeamLWApplication::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.

vtkObject* ssMultibeamLWApplication::MakeTclObject ( const char *  type,
const char *  name 
)

Instantiate a Tcl object.

Parameters:
type The class of the object.
name The name of the object.
Returns:
A vtkObject pointer to the object instantiated.

vtkObject* ssMultibeamLWApplication::TclToVTKObject ( const char *  name  ) 

Give a reference to a Tcl object.

Parameters:
name The name of the object.
Returns:
A vtkObject pointer to the object.

ssMultibeamLWWindow* ssMultibeamLWApplication::Window (  )  const

Give the GUI.

void ssMultibeamLWApplication::GuiProcess ( Tcl_Interp *  interp,
vtkMultiProcessController controller,
int  argc,
char *  argv[] 
)

Start the Gui portion of the object.

Parameters:
interp The Tcl interpreter in use.
controller The controller.
argc The number of components in the argv vector.
argv The comand line argumen vector.

void ssMultibeamLWApplication::SdfProcess ( Tcl_Interp *  interp,
vtkMultiProcessController controller 
)

Start the SDF portion of the object.

Parameters:
interp The Tcl interpreter in use
controller The controller.

vtkMultiProcessController* ssMultibeamLWApplication::GuiProcess (  )  const

Give this object's Gui process controller.

vtkMultiProcessController* ssMultibeamLWApplication::SdfProcess (  )  const

Give this object's Sdf process controller.

virtual int ssMultibeamLWApplication::Exit (  )  [virtual]

Called on exit.

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

Reimplemented from vtkKWApplication.

void ssMultibeamLWApplication::GUIProcess (  ) 

Start the GUI thread.


Friends And Related Function Documentation

void ssMultibeamLWApplication_NavigationDAVRMI ( void *  localArg,
void *  ,
int  ,
int  remoteProcessId 
) [friend]

The navigation data RMI.

Parameters:
localArg The argument provided by the AddRMI().
remoteProcessId The PID of the process issueing the TriggerRMI().

void ssMultibeamLWApplication_BathymetryDAVRMI ( void *  localArg,
void *  ,
int  ,
int  remoteProcessId 
) [friend]

The bathymetry data RMI.

Parameters:
localArg The argument provided by the AddRMI().
remoteProcessId The PID of the process issueing the TriggerRMI().

void ssMultibeamLWApplication_AttitudeDAVRMI ( void *  localArg,
void *  ,
int  ,
int  remoteProcessId 
) [friend]

The attitude data RMI.

Parameters:
localArg The argument provided by the AddRMI().
remoteProcessId The PID of the process issueing the TriggerRMI().

void ssMultibeamLWApplication_TideDAVRMI ( void *  localArg,
void *  ,
int  ,
int  remoteProcessId 
) [friend]

The tide data RMI.

Parameters:
localArg The argument provided by the AddRMI().
remoteProcessId The PID of the process issueing the TriggerRMI().

void ssMultibeamLWApplication_VelocimeterDAVRMI ( void *  localArg,
void *  ,
int  ,
int  remoteProcessId 
) [friend]

The Velocimeter data RMI.

Parameters:
localArg The argument provided by the AddRMI().
remoteProcessId The PID of the process issueing the TriggerRMI().

void ssMultibeamLWApplication_TemperatureDAVRMI ( void *  localArg,
void *  ,
int  ,
int  remoteProcessId 
) [friend]

The temperature data RMI.

Parameters:
localArg The argument provided by the AddRMI().
remoteProcessId The PID of the process issueing the TriggerRMI().

void GUIProcess ( vtkMultiProcessController tlc,
void *  userdata 
) [friend]

void SDFProcess ( vtkMultiProcessController tlc,
void *  userdata 
) [friend]


Member Data Documentation

vtkMultiProcessController* ssMultibeamLWApplication::guiController [protected]

The Gui process controller.

Definition at line 143 of file ssMultibeamLWApplication.h.

vtkMultiProcessController* ssMultibeamLWApplication::sdfController [protected]

The SDF process controller.

Definition at line 148 of file ssMultibeamLWApplication.h.

vtkSocketCommunicator* ssMultibeamLWApplication::navPort [protected]

The navigation input port.

Definition at line 153 of file ssMultibeamLWApplication.h.

vtkSocketCommunicator* ssMultibeamLWApplication::bathyPort [protected]

The bathymetry input port.

Definition at line 158 of file ssMultibeamLWApplication.h.

vtkSocketCommunicator* ssMultibeamLWApplication::attitudePort [protected]

The attitude input port.

Definition at line 163 of file ssMultibeamLWApplication.h.

vtkSocketCommunicator* ssMultibeamLWApplication::tidePort [protected]

The tide input port.

Definition at line 168 of file ssMultibeamLWApplication.h.

vtkSocketCommunicator* ssMultibeamLWApplication::velocimeterPort [protected]

The velocimeter input port.

Definition at line 173 of file ssMultibeamLWApplication.h.

vtkSocketCommunicator* ssMultibeamLWApplication::tempPort [protected]

The temperature input port.

Definition at line 178 of file ssMultibeamLWApplication.h.

ssPolyDatatoPlanStaticFilter* ssMultibeamLWApplication::planFilter [protected]

The filter that is responsible for scrolling the plan view.

Definition at line 183 of file ssMultibeamLWApplication.h.

ssPolyDatatoBathymetryScrollFilter* ssMultibeamLWApplication::swathFilter [protected]

The filter that is responsible for scrolling the swath bathymetry view.

Definition at line 188 of file ssMultibeamLWApplication.h.

ssPolyDatatoAttitudeScrollFilter* ssMultibeamLWApplication::rollFilter [protected]

The filter that is responsible for scrolling the roll view.

Definition at line 193 of file ssMultibeamLWApplication.h.

ssPolyDatatoAttitudeScrollFilter* ssMultibeamLWApplication::pitchFilter [protected]

The filter that is responsible for scrolling the pitch view.

Definition at line 198 of file ssMultibeamLWApplication.h.


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