casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casacore::AipsIOReaderWriter Class Reference

Implementation of CASA region AipsIO file reader and writer. More...

#include <AipsIOReaderWriter.h>

Inheritance diagram for casacore::AipsIOReaderWriter:
casacore::RFReader casacore::RFWriter casacore::RFReaderWriter casacore::RFReaderWriter

Public Member Functions

 AipsIOReaderWriter ()
 Constructor. More...
 ~AipsIOReaderWriter ()
 Destructor. More...
bool read (Record &region)
 RSFileReader methods //. More...
bool read (ImageRegion *&region)
void setOptions (const Record *options)
 RSFileWriter methods //. More...
bool write (const Record &region) const
 Implements RSFileWriter::write. More...
bool write (const ImageRegion &region) const
- Public Member Functions inherited from casacore::RFReader
 RFReader ()
 Constructor. More...
virtual ~RFReader ()
 Destructor. More...
virtual Recordoptions ()
 Provides access to the plotting options that were found in the region file. More...
virtual bool readFile (const String &file, Record &region)
 Calls setFile() then read(). More...
- Public Member Functions inherited from casacore::RFReaderWriter
 RFReaderWriter ()
 Constructor. More...
virtual ~RFReaderWriter ()
 Destructor. More...
virtual void setFile (const String &filename)
 Sets the file to be read/written to the given. More...
virtual void setName (const String &regionName)
 Sets the region name associated withe the file to be read or written. More...
virtual const RFErrorlastError () const
 Returns the last error set during read/write. More...
- Public Member Functions inherited from casacore::RFWriter
 RFWriter ()
 Constructor. More...
virtual ~RFWriter ()
 Destructor. More...
virtual bool writeFile (const String &filename, const Record &regions)
 Calls setFile then write. More...

Additional Inherited Members

- Public Types inherited from casacore::RFReaderWriter
enum  SupportedType {
 An enum of all known subclasses/formats supported. More...
- Static Public Member Functions inherited from casacore::RFReaderWriter
static SupportedType supportedTypes (String type)
 Converts between enum and String for SupportedType. More...
static String supportedTypes (SupportedType type)
static String extensionForType (SupportedType type)
 Returns the file extension for the given SupportedType. More...
static Vector< SupportedTypesupportedTypes ()
 Returns all known SupportedTypes. More...
static Vector< StringsupportedTypeStrings ()
static RFReaderreaderForType (SupportedType type)
 Returns an appropriate child RFReader class for the given SupportedType, or NULL for an error (shouldn't happen). More...
static RFWriterwriterForType (SupportedType type)
 Returns an new appropriate child RfWriter class for the given SupportedType, or NULL for an error (shouldn't happen). More...
static RecordoptionsWidgetForType (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 casacore::RFReaderWriter
virtual void setError (const String &error, bool fatal=false) const
 Convenience method for setting last error during read/write. More...
- Protected Attributes inherited from casacore::RFReaderWriter
 Filename to be read/written. More...
 Name to be assigned to the region. More...
RFError lastError_p
 Last error seen during read/write. More...
Record options_p
 Record containg plotting options for the regions. More...

Detailed Description

Implementation of CASA region AipsIO file reader and writer.

Intended use:

Public interface





To provide a class for reading and writing ImageRegion class records that have been stored into an AipsIO file.

Definition at line 67 of file AipsIOReaderWriter.h.

Constructor & Destructor Documentation

casacore::AipsIOReaderWriter::AipsIOReaderWriter ( )


casacore::AipsIOReaderWriter::~AipsIOReaderWriter ( )


Member Function Documentation

bool casacore::AipsIOReaderWriter::read ( Record region)

RSFileReader methods //.

Implements RSFileReader::read.

Implements casacore::RFReader.

bool casacore::AipsIOReaderWriter::read ( ImageRegion *&  region)
void casacore::AipsIOReaderWriter::setOptions ( const Record options)

RSFileWriter methods //.

Implements RSFileWriter::setOptions.

Reimplemented from casacore::RFWriter.

bool casacore::AipsIOReaderWriter::write ( const Record region) const

Implements RSFileWriter::write.

Implements casacore::RFWriter.

bool casacore::AipsIOReaderWriter::write ( const ImageRegion region) const

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