casacore::RFReader Class Reference

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

#include <RFReaderWriter.h>

Inheritance diagram for casacore::RFReader:

Public Member Functions
	RFReader ()
	Constructor.
virtual	~RFReader ()
	Destructor.
virtual Record *	options ()
	Provides access to the plotting options that were found in the region file.
virtual bool	read (Record &region)=0
	reported, false otherwise.
virtual bool	readFile (const String &file, Record &region)
	Calls setFile() then read().

Detailed Description

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

Intended use:

Public interface

Synopsis

Provide a well defined set of operations for reading region files, regardless of the data format.

Note that some file formats allow for plotting options to be defined as well as the regions. These options are read and stored in a record of ... , the contents of this record is ill-defined (ie. there is no standard).

There may come a time where a standard is necessary.

Example

Definition at line 222 of file RFReaderWriter.h.

Constructor & Destructor Documentation

casacore::RFReader::RFReader ( ) [inline]

Constructor.

Definition at line 226 of file RFReaderWriter.h.

virtual casacore::RFReader::~RFReader ( ) [inline, virtual]

Destructor.

Definition at line 229 of file RFReaderWriter.h.

Member Function Documentation

virtual Record* casacore::RFReader::options ( ) [inline, virtual]

Provides access to the plotting options that were found in the region file.

Definition at line 233 of file RFReaderWriter.h.

References casacore::RFReaderWriter::options_p.

virtual bool casacore::RFReader::read ( Record & region ) [pure virtual]

reported, false otherwise.

If false is returned, the details can be found using lastError(). Any valid Regions that were read from the file are placed in the given vector (which is cleared first).

Implemented in casacore::AipsIOReaderWriter.

Referenced by readFile().

virtual bool casacore::RFReader::readFile	(	const String &	file,
		Record &	region
	)			`[inline, virtual]`

Calls setFile() then read().

Definition at line 244 of file RFReaderWriter.h.

References read(), and casacore::RFReaderWriter::setFile().

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

casacore/images/Regions/RFReaderWriter.h