FiletoPoly Class Reference
[C++/Common/DataSource/FiletoPoly]

This is the base class for all FiletoPoly classes to be implemented. More...

#include <FiletoPoly.h>

Inheritance diagram for FiletoPoly:

Inheritance graph
[legend]
Collaboration diagram for FiletoPoly:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FiletoPoly (const char *pathname)
 Ctor.
virtual ~FiletoPoly ()
 Dtor.
bool go () const
 Is this object Go?
bool ok () const
 Is this object ok?
vtkPolyDataGetOutput () const
 Give the filter output.
vtkPolyDataGetDecimatedOutput ()
 Give the decimated filter output.
void decimate (float arg)
 Specify the decimation factor to use for the above output.
float decimate () const
 Give the decimation factor currently in use.
virtual vtkDataSetGetReaderOutput () const=0
 Give the output of the input reader.
std::string classType () const
 Give the class type.
virtual void ReleaseDataFlagOn ()
 Release memory as it has been used (i.e.
virtual void ReleaseDataFlagOff ()
 Keep memory once it has been allocated (i.e.
virtual void SetReleaseDataFlag (bool dynamic)
 Specify the memory management policy.
virtual bool GetReleaseDataFlag () const
 Give the memory management policy.
void DebugOn ()
 Set the class debugging to on.
void DebugOff ()
 Set the class debugging to off.
unsigned int GetDebug () const
 Give the debugging status of the object.

Protected Attributes

const char * pathname
 The data source file.
vtkPolyDataoutput
 The output port.
GoNogo state
 The major state of this object.
std::string className
 The name of the class.
vtkDecimateProdecimator
 The Decimator.

Detailed Description

This is the base class for all FiletoPoly classes to be implemented.

The FiletoPoly sub classes will read data in a certain format and convert it to data from a PolyDataSource. The classes derived from this are the enumeration of the several data types that can be read and converted to a PolyDataSource.

Definition at line 24 of file FiletoPoly.h.


Constructor & Destructor Documentation

FiletoPoly::FiletoPoly ( const char *  pathname  ) 

Ctor.

Parameters:
pathname The FQN of the input file.

virtual FiletoPoly::~FiletoPoly (  )  [virtual]

Dtor.


Member Function Documentation

bool FiletoPoly::go (  )  const

Is this object Go?

Returns:
True if Go.

bool FiletoPoly::ok (  )  const

Is this object ok?

Returns:
True if ok.

vtkPolyData* FiletoPoly::GetOutput (  )  const

Give the filter output.

Returns:
The PolyData output.

vtkPolyData* FiletoPoly::GetDecimatedOutput (  ) 

Give the decimated filter output.

Returns:
The PolyData output.

void FiletoPoly::decimate ( float  arg  ) 

Specify the decimation factor to use for the above output.

Parameters:
arg The variable, 0.0 <= arg < 1.0, representing the decimation factor. A value of 0.0 is no decimation and 1.0 is 100% decimation.

float FiletoPoly::decimate (  )  const

Give the decimation factor currently in use.

Returns:
The decimation factor, 0.0 <= return < 1.0, in use.

virtual vtkDataSet* FiletoPoly::GetReaderOutput (  )  const [pure virtual]

Give the output of the input reader.

Returns:
The output of the input reader in the data type of the reader.

Implemented in PolyFiletoPoly, and StructuredPointsFiletoPoly.

std::string FiletoPoly::classType (  )  const

Give the class type.

Returns:
The class type as set by the sub class.

virtual void FiletoPoly::ReleaseDataFlagOn (  )  [virtual]

Release memory as it has been used (i.e.

dynamic memory management).

virtual void FiletoPoly::ReleaseDataFlagOff (  )  [virtual]

Keep memory once it has been allocated (i.e.

static memnory management).

virtual void FiletoPoly::SetReleaseDataFlag ( bool  dynamic  )  [virtual]

Specify the memory management policy.

Parameters:
dynamic If dynamic management is specified then true.

Reimplemented in PolyFiletoPoly, and StructuredPointsFiletoPoly.

virtual bool FiletoPoly::GetReleaseDataFlag (  )  const [virtual]

Give the memory management policy.

Returns:
If the policy is dynamic then true.

void FiletoPoly::DebugOn (  ) 

Set the class debugging to on.

void FiletoPoly::DebugOff (  ) 

Set the class debugging to off.

unsigned int FiletoPoly::GetDebug (  )  const

Give the debugging status of the object.

Returns:
Non zero if debugging on.


Member Data Documentation

const char* FiletoPoly::pathname [protected]

The data source file.

Definition at line 134 of file FiletoPoly.h.

vtkPolyData* FiletoPoly::output [protected]

The output port.

Definition at line 139 of file FiletoPoly.h.

GoNogo FiletoPoly::state [protected]

The major state of this object.

Definition at line 144 of file FiletoPoly.h.

std::string FiletoPoly::className [protected]

The name of the class.

Set by the drevied class to the correct name.

Definition at line 149 of file FiletoPoly.h.

vtkDecimatePro* FiletoPoly::decimator [protected]

The Decimator.

Definition at line 154 of file FiletoPoly.h.


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