PolyDataInstrument Class Reference
[C++/Mechanization/SwathInstrument/PolyDataInstrument]

The purpose of this class is to implement a hypothetical "Poly Data Multibeam" instrument. More...

#include <PolyDataInstrument.h>

Inheritance diagram for PolyDataInstrument:

Inheritance graph
[legend]
Collaboration diagram for PolyDataInstrument:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (PolyDataInstrument, MultibeamInstrument)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the internal state.
void SetFileName (const char *path)
 Specify the input file.
void Tickle ()
 Tickle int input file reader.
bool PopRecord ()
 Indicate whether there is a record of any type to process.

Static Public Member Functions

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

Protected Member Functions

 PolyDataInstrument ()
 Ctor.
virtual ~PolyDataInstrument ()
virtual void Execute ()
 Execute the dataflow.
virtual void ReadInputRecord ()
 Read a single record from the input stream.

Detailed Description

The purpose of this class is to implement a hypothetical "Poly Data Multibeam" instrument.

This instrument is used for testing and system developement and has no utility otherwise.

The input to an object of this class is a series of Poly Data Records (i.e. written by ssPolyDataRecordWriter). Each of these records has a type which is indicated by the return from vtkDataReader::GetHeader() (i.e. the "Indicator" column below).

The arrangement of the various records are shown here

Definition at line 31 of file PolyDataInstrument.h.


Constructor & Destructor Documentation

PolyDataInstrument::PolyDataInstrument (  )  [protected]

Ctor.

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


Member Function Documentation

static PolyDataInstrument* PolyDataInstrument::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 MultibeamInstrument.

PolyDataInstrument::vtkTypeMacro ( PolyDataInstrument  ,
MultibeamInstrument   
)

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

Print the internal state.

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

Reimplemented from MultibeamInstrument.

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

Specify the input file.

Parameters:
path The fqpn of the input file.

Reimplemented from MultibeamInstrument.

void PolyDataInstrument::Tickle (  )  [virtual]

Tickle int input file reader.

Reimplemented from MultibeamInstrument.

bool PolyDataInstrument::PopRecord (  )  [virtual]

Indicate whether there is a record of any type to process.

Returns:
If there is a record then true.

Reimplemented from MultibeamInstrument.

virtual void PolyDataInstrument::Execute (  )  [protected, virtual]

Execute the dataflow.

Reimplemented from MultibeamInstrument.

virtual void PolyDataInstrument::ReadInputRecord (  )  [protected, virtual]

Read a single record from the input stream.

Reimplemented from MultibeamInstrument.


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