ssEditFileWriter Class Reference
[C++/Common/Vtk/ReaderWriter]

The purpose of this class is to implement the writing of "edit" files. More...

#include <ssEditFileWriter.h>

Inheritance diagram for ssEditFileWriter:

Inheritance graph
[legend]
Collaboration diagram for ssEditFileWriter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (ssEditFileWriter, ssRawDataWriter)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the internal state.
virtual ostream * OpenVTKFile ()
 Open the current file in the current mode.
virtual void TruncateFile ()
 Truncate or create a zero length file.
void PointsPerLine (vtkIdType n)
 Specify the points per line.
void Seek (vtkIdType loc)
 Set the position pointer to the start of the indicated position.
vtkIdType Tell () const
 Give the current file position.

Static Public Member Functions

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

Protected Member Functions

 ssEditFileWriter ()
 Ctor.
virtual ~ssEditFileWriter ()
 Dtor.
virtual void WriteData ()
 Write out the currently avaliable data.

Detailed Description

The purpose of this class is to implement the writing of "edit" files.

Edit files are those that are written by the output of the virtual sonar instrument and are used by the editing tool.

Definition at line 21 of file ssEditFileWriter.h.


Constructor & Destructor Documentation

ssEditFileWriter::ssEditFileWriter (  )  [protected]

Ctor.

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

Dtor.


Member Function Documentation

static ssEditFileWriter* ssEditFileWriter::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 ssRawDataWriter.

ssEditFileWriter::vtkTypeMacro ( ssEditFileWriter  ,
ssRawDataWriter   
)

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

Print the internal state.

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

Reimplemented from ssRawDataWriter.

virtual ostream* ssEditFileWriter::OpenVTKFile (  )  [virtual]

Open the current file in the current mode.

The file set will be opened in append mode. If it is necessary to overwrite an existing file set from the begining use TruncateFile() before writing. Problems will cause not Ok or NOGO status to be set.

Returns:
The output stream of the meta file or null of it could not be opened.

Reimplemented from ssRawDataWriter.

virtual void ssEditFileWriter::TruncateFile (  )  [virtual]

Truncate or create a zero length file.

Reimplemented from ssRawDataWriter.

void ssEditFileWriter::PointsPerLine ( vtkIdType  n  ) 

Specify the points per line.

This should be done after OpenVTKFile() and before any Seek() is done!

Parameters:
n The number of points per line.

void ssEditFileWriter::Seek ( vtkIdType  loc  ) 

Set the position pointer to the start of the indicated position.

Parameters:
loc The line position.

vtkIdType ssEditFileWriter::Tell (  )  const

Give the current file position.

Returns:
Current position in lines.

virtual void ssEditFileWriter::WriteData (  )  [protected, virtual]

Write out the currently avaliable data.

Reimplemented from vtkDataWriter.


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