casa::RSFileReader Class Reference

Abstract superclass for any class that reads a format that produces RegionShapes from a file. More...

#include <RSFileReaderWriter.h>

Inheritance diagram for casa::RSFileReader:

Public Member Functions
	RSFileReader ()
	Constructor. More...
virtual	~RSFileReader ()
	Destructor. More...
virtual bool	read (std::vector< RegionShape * > &readShapes)=0
	Read the filename set with setFile and returns true if no errors were reported, false otherwise. More...
virtual bool	readFile (const casacore::String &file, std::vector< RegionShape * > &shapes)
	Calls setFile() then read(). More...
Public Member Functions inherited from casa::RSFileReaderWriter
	RSFileReaderWriter ()
	Non-Static Members //. More...
virtual	~RSFileReaderWriter ()
	Destructor. More...
virtual void	setFile (const casacore::String &filename)
	Sets the file to be read/written to the given. More...
virtual const RFError &	lastError () const
	Returns the last error set during read/write. More...

Additional Inherited Members
Public Types inherited from casa::RSFileReaderWriter
enum	SupportedType {   DS9,   CASA_XML }
	Public Static Methods //. More...
Static Public Member Functions inherited from casa::RSFileReaderWriter
static SupportedType	supportedType (casacore::String type)
	Converts between enum and casacore::String for SupportedType. More...
static casacore::String	supportedType (SupportedType type)
static casacore::String	extensionForType (SupportedType type)
	Returns the file extension for the given SupportedType. More...
static std::vector< SupportedType >	supportedTypes ()
	Returns all known SupportedTypes. More...
static std::vector < casacore::String >	supportedTypesStrings ()
static RSFileReader *	readerForType (SupportedType type)
	Returns an appropriate child RegionFileReader class for the given SupportedType, or NULL for an error (shouldn't happen). More...
static RSFileWriter *	writerForType (SupportedType type)
	Returns an new appropriate child RegionFileWriter class for the given SupportedType, or NULL for an error (shouldn't happen). More...
static QWidget *	optionsWidgetForType (SupportedType type)
	Returns an new appropriate options widget for the given SupportedType, or NULL for an error (shouldn't happen). More...
Protected Member Functions inherited from casa::RSFileReaderWriter
virtual void	setError (const casacore::String &error, bool isFatal=false) const
	Convenience method for setting last error during read/write. More...
Protected Attributes inherited from casa::RSFileReaderWriter
casacore::String	m_filename
	Filename to be read/written. More...
RFError	m_lastError
	Last error seen during read/write. More...

Detailed Description

Abstract superclass for any class that reads a format that produces RegionShapes from a file.

Definition at line 143 of file RSFileReaderWriter.h.

Constructor & Destructor Documentation

casa::RSFileReader::RSFileReader ( )

inline

Constructor.

Definition at line 146 of file RSFileReaderWriter.h.

virtual casa::RSFileReader::~RSFileReader ( )

inlinevirtual

Destructor.

Definition at line 149 of file RSFileReaderWriter.h.

Member Function Documentation

virtual bool casa::RSFileReader::read ( std::vector< RegionShape * > &  readShapes )

pure virtual

Read 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(). Any valid RegionShapes that were read from the file are placed in the given vector (which is cleared first).

Implemented in casa::DS9FileReader, and casa::XMLFileReaderWriter.

virtual bool casa::RSFileReader::readFile ( const casacore::String &  file, std::vector< RegionShape * > &  shapes  )

inlinevirtual

Calls setFile() then read().

Definition at line 158 of file RSFileReaderWriter.h.

---

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

• casa/code/display/RegionShapes/RSFileReaderWriter.h