ssGenerateSwath Class Reference
[Simulator/Common/C++]

#include <ssGenerateSwath.h>

Inheritance diagram for ssGenerateSwath:

Inheritance graph
[legend]
Collaboration diagram for ssGenerateSwath:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (ssGenerateSwath, vtkPolyDataReader)
void InstrumentParameters (const ssInstrumentParameters *parameters)
 Specify the virtual instrument parameters.
void transducer (double x, double y, double z)
 Specify the virtual transducer position.
void attitude (double heading, double pitch, double roll)
 Specify the attitude.
void PrintSelf (ostream &os, vtkIndent indent)
 Print the internal state.
virtual void DebugOn ()
 Turn debug status on.
virtual void DebugOff ()
 Turn the debug status off.

Static Public Member Functions

static ssGenerateSwathNew ()
 Construct a new object of this class.

Protected Member Functions

void Execute ()
 Perform the filtering.
 ssGenerateSwath ()
 Ctor.
virtual ~ssGenerateSwath ()
 Dtor.

Detailed Description

Definition at line 21 of file ssGenerateSwath.h.


Constructor & Destructor Documentation

ssGenerateSwath::ssGenerateSwath (  )  [protected]

Ctor.

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

Dtor.


Member Function Documentation

static ssGenerateSwath* ssGenerateSwath::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 vtkPolyDataReader.

ssGenerateSwath::vtkTypeMacro ( ssGenerateSwath  ,
vtkPolyDataReader   
)

void ssGenerateSwath::InstrumentParameters ( const ssInstrumentParameters parameters  ) 

Specify the virtual instrument parameters.

Parameters:
parameters The instrument parameters.

void ssGenerateSwath::transducer ( double  x,
double  y,
double  z 
)

Specify the virtual transducer position.

Parameters:
x The transducer x coordinate.
y The transducer y coordinate.
z The transducer z coordinate.

void ssGenerateSwath::attitude ( double  heading,
double  pitch,
double  roll 
)

Specify the attitude.

The origin of the heading is east and it increases in a counter clockwise direction. The pitch axis is in the x, y plane and is at right angles to the heading. The roll axis is in the x, y plane and is coincident with the heading. "Bow up" is positive as is "roll right".

Parameters:
heading The heading of the virtual vessel.
pitch The pitch of the virtual vessel.
roll The roll of the virtual vessel.

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

Print the internal state.

Parameters:
os The destination stream.
indent The indentation to use.

Reimplemented from vtkPolyDataReader.

virtual void ssGenerateSwath::DebugOn (  )  [virtual]

Turn debug status on.

Reimplemented from vtkObject.

virtual void ssGenerateSwath::DebugOff (  )  [virtual]

Turn the debug status off.

Reimplemented from vtkObject.

void ssGenerateSwath::Execute (  )  [protected]

Perform the filtering.


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