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:
casa::RSFileReaderWriter casa::DS9FileReader casa::XMLFileReaderWriter

List of all members.

Public Member Functions

 RSFileReader ()
 Constructor.
virtual ~RSFileReader ()
 Destructor.
virtual bool read (vector< RegionShape * > &readShapes)=0
 Read the filename set with setFile and returns true if no errors were reported, false otherwise.
virtual bool readFile (const String &file, vector< RegionShape * > &shapes)
 Calls setFile() then read().

Detailed Description

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

Definition at line 142 of file RSFileReaderWriter.h.


Constructor & Destructor Documentation

casa::RSFileReader::RSFileReader (  )  [inline]

Constructor.

Definition at line 145 of file RSFileReaderWriter.h.

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

Destructor.

Definition at line 148 of file RSFileReaderWriter.h.


Member Function Documentation

virtual bool casa::RSFileReader::read ( 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.

Referenced by readFile().

virtual bool casa::RSFileReader::readFile ( const String &  file,
vector< RegionShape * > &  shapes 
) [inline, virtual]

Calls setFile() then read().

Definition at line 157 of file RSFileReaderWriter.h.

References read(), and casa::RSFileReaderWriter::setFile().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1