casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
casa::RFReaderWriter Class Reference

Superclass for readers and writers containing common definitions and operations. More...

#include <RFReaderWriter.h>

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

List of all members.

Public Types

enum  SupportedType {
  AIPS_BOX,
  DS9,
  CASA_XML,
  AIPS_IO
}
 An enum of all known subclasses/formats supported. More...

Public Member Functions

 RFReaderWriter ()
 Constructor.
virtual ~RFReaderWriter ()
 Destructor.
virtual void setFile (const String &filename)
 Sets the file to be read/written to the given.
virtual void setName (const String &regionName)
 Sets the region name associated withe the file to be read or written.
virtual const RFErrorlastError () const
 Returns the last error set during read/write.

Static Public Member Functions

static SupportedType supportedTypes (String type)
 Converts between enum and String for SupportedType.
static String supportedTypes (SupportedType type)
static String extensionForType (SupportedType type)
 Returns the file extension for the given SupportedType.
static Vector< SupportedTypesupportedTypes ()
 Returns all known SupportedTypes.
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).
static RFWriterwriterForType (SupportedType type)
 Returns an new appropriate child RfWriter class for the given SupportedType, or NULL for an error (shouldn't happen).
static RecordoptionsWidgetForType (SupportedType type)
 Returns an new appropriate options widget for the given SupportedType, or NULL for an error (shouldn't happen).

Protected Member Functions

virtual void setError (const String &error, bool fatal=false) const
 Convenience method for setting last error during read/write.

Protected Attributes

StringpFilename_p
 Filename to be read/written.
StringpRegionName_p
 Name to be assigned to the region.
RFError lastError_p
 Last error seen during read/write.
Record options_p
 Record containg plotting options for the regions.

Detailed Description

Superclass for readers and writers containing common definitions and operations.

Intended use:

Public interface

Synopsis

Example

Definition at line 118 of file RFReaderWriter.h.


Member Enumeration Documentation

An enum of all known subclasses/formats supported.

Enumerator:
AIPS_BOX 
DS9 
CASA_XML 
AIPS_IO 

Definition at line 122 of file RFReaderWriter.h.


Constructor & Destructor Documentation

Constructor.

Definition at line 155 of file RFReaderWriter.h.

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

Destructor.

Definition at line 158 of file RFReaderWriter.h.


Member Function Documentation

Returns the file extension for the given SupportedType.

virtual const RFError& casa::RFReaderWriter::lastError ( ) const [virtual]

Returns the last error set during read/write.

Returns an new appropriate options widget for the given SupportedType, or NULL for an error (shouldn't happen).

Returns an appropriate child RFReader class for the given SupportedType, or NULL for an error (shouldn't happen).

virtual void casa::RFReaderWriter::setError ( const String error,
bool  fatal = false 
) const [protected, virtual]

Convenience method for setting last error during read/write.

virtual void casa::RFReaderWriter::setFile ( const String filename) [virtual]

Sets the file to be read/written to the given.

Referenced by casa::RFReader::readFile(), and casa::RFWriter::writeFile().

virtual void casa::RFReaderWriter::setName ( const String regionName) [virtual]

Sets the region name associated withe the file to be read or written.

Converts between enum and String for SupportedType.

Returns all known SupportedTypes.

Returns an new appropriate child RfWriter class for the given SupportedType, or NULL for an error (shouldn't happen).


Member Data Documentation

Last error seen during read/write.

Definition at line 177 of file RFReaderWriter.h.

Record containg plotting options for the regions.

Definition at line 180 of file RFReaderWriter.h.

Referenced by casa::RFReader::options(), and casa::RFWriter::setOptions().

Filename to be read/written.

Definition at line 171 of file RFReaderWriter.h.

Name to be assigned to the region.

Definition at line 174 of file RFReaderWriter.h.


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