casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AipsIOReaderWriter.h
Go to the documentation of this file.
1 //# AipsIOReaderWriter.h: Implementation for reading/writing CASA AipsIO region files produced by the viewer.
2 //# Copyright (C) 2008
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be addressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //# $Id$
27 
28 #ifndef IMAGES_AIPSIOREADERWRITER_H
29 #define IMAGES_AIPSIOREADERWRITER_H
30 
31 //# Includes
32 #include <casacore/casa/aips.h>
35 
36 namespace casacore { //# NAMESPACE CASACORE - BEGIN
37 
38 // <summary>
39 // Implementation of CASA region AipsIO file reader and writer
40 // </summary>
41 //
42 // <use visibility=export>
43 //
44 // <reviewed reviewer="" date="" tests="">
45 // </reviewed>
46 //
47 // <prerequisite>
48 // <li> <linkto class=RFReaderWriter>RFReaderWriter</linkto>
49 // </prerequisite>
50 //
51 // <synopsis>
52 // </synopsis>
53 //
54 // <example>
55 // <srcblock>
56 // </srcblock>
57 // </example>
58 //
59 // <motivation>
60 // To provide a class for reading and writing ImageRegion class records that
61 // have been stored into an AipsIO file.
62 // </motivation>
63 //
64 //# <todo asof="1998/05/20">
65 //# </todo>
66 
67 class AipsIOReaderWriter : public RFReader, public RFWriter
68 {
69 public:
70  // Constructor.
72 
73  // Destructor.
75 
76  // RSFileReader methods //
77 
78  //<group>
79  // Implements RSFileReader::read.
80  bool read(Record& region);
81  bool read(ImageRegion*& region);
82  //</group>
83 
84 
85  // RSFileWriter methods //
86 
87  // Implements RSFileWriter::setOptions.
88  void setOptions(const Record* options);
89 
90  //<group>
91  // Implements RSFileWriter::write
92  bool write(const Record& region) const;
93  bool write(const ImageRegion& region) const;
94  //</group>
95 };
96 
97 } //# end namespace
98 
99 #endif
AipsIOReaderWriter()
Constructor.
Abstract superclass for any class that reads a format that produces Regions from a file...
Abstract superclass for any class that writes Regions to a region file format.
Implementation of CASA region AipsIO file reader and writer.
void setOptions(const Record *options)
RSFileWriter methods //.
bool read(Record &region)
RSFileReader methods //.
A hierarchical collection of named fields of various types.
Definition: Record.h:180
~AipsIOReaderWriter()
Destructor.
Class to hold a region of interest in an image.
Definition: ImageRegion.h:86
virtual Record * options()
Provides access to the plotting options that were found in the region file.
bool write(const Record &region) const
Implements RSFileWriter::write.