Multibeam]

This is the super class for all multibeam swath sonars. More...

#include <MultibeamInstrument.h>

Inheritance diagram for MultibeamInstrument:

[legend]Collaboration diagram for MultibeamInstrument:


Public Types
enum	OutputIndex { BATHYMETRY, ATTITUDE, NAVIGATION, TIDE, VELOCIMETER, TEMPERATURE }
Public Member Functions
	vtkTypeMacro (MultibeamInstrument, vtkSource)
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the internal state.
virtual void	SetFileName (const char *path)
	Do nothing.
void	Process (SMARTP(vtkMultiProcessController) controller)
	Specify the Process (if any) that runs this Instrument.
	SMARTP (vtkMultiProcessController) Process() const
	Give the Process (if any) that runs this Instrument.
void	Initialize ()
	Initialize the object by configuring the IPC elements.
	SMARTP (vtkPolyData) GetOutput()
	Give output 0.
	SMARTP (vtkPolyData) GetOutput(OutputIndex level)
	Give a specified output.
	SMARTP (vtkPolyData) BathymetryOutput()
	Give the bathymetry output.
	SMARTP (vtkPolyData) AttitudeOutput()
	Give the attitude output.
	SMARTP (vtkPolyData) NavigationOutput()
	Give the navigation output.
	SMARTP (vtkPolyData) TideOutput()
	Give the tide output.
	SMARTP (vtkPolyData) VelocimeterOutput()
	Give the velocimeter output.
	SMARTP (vtkPolyData) TemperatureOutput()
	Give the temperature output.
virtual void	Update ()
	Update this object with respect to the input.
virtual void	Tickle ()
	Do nothing.
virtual bool	PopRecord ()
	Indicate whether there is a record of any type to process.
Static Public Member Functions
static MultibeamInstrument *	New ()
	Construct a new object of this class.
Protected Member Functions
	MultibeamInstrument ()
	Ctor.
	~MultibeamInstrument ()
	Dtor.
virtual void	Execute ()
	Execute the dataflow.
virtual void	ReadInputRecord ()
	Get the nextInputRecord.
void	ComputeInputUpdateExtents (vtkDataObject *data)
	Compute the input extents.
Protected Attributes
int	ExecutePiece
int	ExecuteNumberOfPieces
int	ExecuteGhostLevel
vtkMultiProcessController *	controller
	The process controller.

Detailed Description

This is the super class for all multibeam swath sonars.

The classes derived from this class will implement the functionality for the specific instruments.

The main purpose of this super class is to specify the API for a virtual multibeam instrument. There are some data that are required by the downstream dataflow and derived classes must provide these. In Addition there are some data that it may be usefull to provide and the derived classes may provide these.

Data that must be provided are:

xyz sounding data that has been stabilized by roll, pitch and heading.
Roll, pitch, heading and heave that is coincident with the sounding data.

Data that may optionally be supplied are:

Navigation data including transducer xyz and velocity.
Tidal data.
Velocimeter data.
Water temperature at transducer.

In general, objects of this class are not synchronized with respect to the input data. Synchronization is achieved by an external agent calling this object's Update() the appropiate number of times. This will cause the synchronization of this object to the input and the synchroniztion of down stream objects to this object.

Definition at line 55 of file MultibeamInstrument.h.

Member Enumeration Documentation

enum MultibeamInstrument::OutputIndex

Enumerator:

BATHYMETRY
ATTITUDE
NAVIGATION
TIDE
VELOCIMETER
TEMPERATURE

Definition at line 60 of file MultibeamInstrument.h.

Constructor & Destructor Documentation

MultibeamInstrument::MultibeamInstrument ( ) [protected]

Ctor.

MultibeamInstrument::~MultibeamInstrument ( ) [protected]

Dtor.

Member Function Documentation

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

Construct a new object of this class.

This is the only method that objects of this class may be brought into existance.

Reimplemented from vtkAlgorithm.

Reimplemented in PolyDataInstrument.

MultibeamInstrument::vtkTypeMacro	(	MultibeamInstrument	,
		vtkSource
	)

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

Print the internal state.

Parameters:

	os	The destination stream.
	indent	The indentation to use.

Reimplemented from vtkSource.

Reimplemented in PolyDataInstrument.

virtual void MultibeamInstrument::SetFileName ( const char * path ) [virtual]

Do nothing.

This function is meant to be overloaded if necessary.

Parameters:

path

The FQPN of the input file.

Reimplemented in PolyDataInstrument.

void MultibeamInstrument::Process ( SMARTP(vtkMultiProcessController) controller )

Specify the Process (if any) that runs this Instrument.

Parameters:

controller

The process controller.

MultibeamInstrument::SMARTP ( vtkMultiProcessController ) const

Give the Process (if any) that runs this Instrument.

Returns:: The process controller: 0 if none.

void MultibeamInstrument::Initialize ( )

Initialize the object by configuring the IPC elements.