casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
casa::RSFileWriter Class Reference

Abstract superclass for any class that writes RegionShapes to a region file format. More...

#include <RSFileReaderWriter.h>

Inheritance diagram for casa::RSFileWriter:
casa::RSFileReaderWriter casa::DS9FileWriter casa::XMLFileReaderWriter

List of all members.

Public Member Functions

 RSFileWriter ()
 Constructor.
virtual ~RSFileWriter ()
 Destructor.
virtual QWidget * optionsWidget () const =0
 Provides a custom widget that can be used to get/set options specific to each format type.
virtual void setOptions (const QWidget *widget)=0
 Sets the options to the values given in the widget.
virtual bool write (const vector< RegionShape * > &shapes) const =0
 Write the given regions to the filename set with setFile and returns true if no errors were reported, false otherwise.
virtual bool writeFile (const String &filename, const vector< RegionShape * > &shapes)
 Calls setFile then write.

Detailed Description

Abstract superclass for any class that writes RegionShapes to a region file format.

Definition at line 166 of file RSFileReaderWriter.h.


Constructor & Destructor Documentation

Constructor.

Definition at line 169 of file RSFileReaderWriter.h.

virtual casa::RSFileWriter::~RSFileWriter ( ) [inline, virtual]

Destructor.

Definition at line 172 of file RSFileReaderWriter.h.


Member Function Documentation

virtual QWidget* casa::RSFileWriter::optionsWidget ( ) const [pure virtual]

Provides a custom widget that can be used to get/set options specific to each format type.

Implemented in casa::XMLFileReaderWriter.

virtual void casa::RSFileWriter::setOptions ( const QWidget *  widget) [pure virtual]

Sets the options to the values given in the widget.

May ignore invalid widgets (i.e., widgets different from the kind provided by optionsWidget()).

Implemented in casa::XMLFileReaderWriter.

virtual bool casa::RSFileWriter::write ( const vector< RegionShape * > &  shapes) const [pure virtual]

Write the given regions to the filename set with setFile and returns true if no errors were reported, false otherwise.

If false is returned, the details can be found using lastError().

Implemented in casa::XMLFileReaderWriter.

virtual bool casa::RSFileWriter::writeFile ( const String filename,
const vector< RegionShape * > &  shapes 
) [inline, virtual]

Calls setFile then write.

Definition at line 189 of file RSFileReaderWriter.h.

References write().


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