casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
VLASourceFilter.h
Go to the documentation of this file.
00001 //# VLASourceFilter.h: 
00002 //# Copyright (C) 1999,2000
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //#
00027 //# $Id$
00028 
00029 #ifndef NRAO_VLASOURCEFILTER_H
00030 #define NRAO_VLASOURCEFILTER_H
00031 
00032 #include <casa/aips.h>
00033 #include <nrao/VLA/VLAFilter.h>
00034 #include <casa/BasicSL/String.h>
00035 #include <casa/BasicSL/Constants.h>
00036 
00037 #include <casa/namespace.h>
00038 class VLALogicalRecord;
00039 
00040 // <summary>
00041 // </summary>
00042 
00043 // <use visibility=export>
00044 
00045 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
00046 // </reviewed>
00047 
00048 // <prerequisite>
00049 //   <li> SomeClass
00050 //   <li> SomeOtherClass
00051 //   <li> some concept
00052 // </prerequisite>
00053 //
00054 // <etymology>
00055 // </etymology>
00056 //
00057 // <synopsis>
00058 // </synopsis>
00059 //
00060 // <example>
00061 // </example>
00062 //
00063 // <motivation>
00064 // </motivation>
00065 //
00066 // <templating arg=T>
00067 //    <li>
00068 //    <li>
00069 // </templating>
00070 //
00071 // <thrown>
00072 //    <li>
00073 //    <li>
00074 // </thrown>
00075 //
00076 // <todo asof="yyyy/mm/dd">
00077 //   <li> add this feature
00078 //   <li> fix this bug
00079 //   <li> start discussion of this possible extension
00080 // </todo>
00081 
00082 class VLASourceFilter: public VLAFilter
00083 {
00084 public:
00085   // The default constructor creats a filter that does not filter
00086   // anything. ie., the passThru() function always returns True;
00087   VLASourceFilter();
00088 
00089   // Creates a filter that filters all records except those with a source name
00090   // that matches (case insensitive) the specified source name. If a qualifier
00091   // is specified (and is not the magic value of INT_MIN), then the qualifier
00092   // also has to match.
00093   VLASourceFilter(const String& sourceName, const Int sourceQual=INT_MIN, const Bool keepblanks=False);
00094 
00095   // The copy constructor uses copy semantics.
00096   VLASourceFilter(const VLASourceFilter& other);
00097 
00098   // The destructor is trivial
00099   virtual ~VLASourceFilter();
00100 
00101   // The assignment operator uses copy semantics.
00102   VLASourceFilter& operator=(const VLASourceFilter& other);
00103 
00104   // returns True if the supplied record has an observing id that matches (case
00105   // insensitive) the source name specified in the constructor.
00106   virtual Bool passThru(const VLALogicalRecord& record) const;
00107 
00108   // Return a pointer to a copy of the VLASourceFilter object upcast to a
00109   // VLAFilter object. The class that uses this function is responsible for
00110   // deleting the pointer. This is used to implement a virtual copy
00111   // constructor.
00112   virtual VLAFilter* clone() const;
00113 
00114   // Function which checks the internal data of this class for correct
00115   // dimensionality and consistant values. Returns True if everything is fine
00116   // otherwise returns False.
00117   virtual Bool ok() const;
00118 
00119 private:
00120   String itsSource;
00121   Int itsQual;
00122   Bool itsKeepBlanks;
00123 };
00124 #endif
00125 
00126