Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.atnf.csiro.au/computing/software/casacore/casacore-1.2.0/doc/html/classcasa_1_1RFReader.html
Дата изменения: Unknown
Дата индексирования: Mon Feb 14 21:08:01 2011
Кодировка:
Поисковые слова: clouds
casacore: casa::RFReader Class Reference
Public Member Functions

casa::RFReader Class Reference
[Regions_module]

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

#include <RFReaderWriter.h>

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

List of all members.

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 221 of file RFReaderWriter.h.


Constructor & Destructor Documentation






      

        

          casa::RFReader::RFReader 
          (
          
           ) 
           [inline]
        

      







Constructor. 



Definition at line 225 of file RFReaderWriter.h.











      

        

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

      







Destructor. 



Definition at line 228 of file RFReaderWriter.h.







Member Function Documentation






      

        

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

      







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



Definition at line 232 of file RFReaderWriter.h.



References casa::RFReaderWriter::options_p.











      

        

          virtual bool casa::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). 



Referenced by readFile().











      

        

          virtual bool casa::RFReader::readFile 
          (
          const String & 
           file, 
        

        

          
          
          Record & 
           region 
        

        

          
          )
           [inline, virtual]
        

      







Calls setFile() then read(). 



Definition at line 243 of file RFReaderWriter.h.



References read(), and casa::RFReaderWriter::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 Fri Sep 3 2010 13:08:23 for casacore by 

doxygen 1.7.1