00001 //# MSSourceIndex: index into a MeasurementSet SOURCE subtable 00002 //# Copyright (C) 2000,2001,2002 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 MS_MSSOURCEINDEX_H 00030 #define MS_MSSOURCEINDEX_H 00031 00032 #include <casacore/casa/aips.h> 00033 #include <casacore/ms/MSSel/MSTableIndex.h> 00034 #include <casacore/ms/MeasurementSets/MSSourceColumns.h> 00035 00036 #include <casacore/casa/Containers/RecordField.h> 00037 00038 namespace casacore { //# NAMESPACE CASACORE - BEGIN 00039 00040 //# forward declarations 00041 class MSSource; 00042 00043 // <summary> 00044 // </summary> 00045 00046 // <use visibility=export> 00047 00048 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos=""> 00049 // </reviewed> 00050 00051 // <prerequisite> 00052 // <li> MeasurementSet 00053 // <li> MSTableIndex 00054 // </prerequisite> 00055 // 00056 // <etymology> 00057 // </etymology> 00058 // 00059 // <synopsis> 00060 // </synopsis> 00061 // 00062 // <example> 00063 // </example> 00064 // 00065 // <motivation> 00066 // </motivation> 00067 // 00068 // <thrown> 00069 // <li> 00070 // <li> 00071 // </thrown> 00072 // 00073 00074 class MSSourceIndex : public MSTableIndex 00075 { 00076 public: 00077 // no index attached, use the attach function or assignment operator to change that 00078 MSSourceIndex(); 00079 00080 // construct one using the indicated SOURCE table 00081 MSSourceIndex(const MSSource &source); 00082 00083 // construct one from another 00084 MSSourceIndex(const MSSourceIndex &other); 00085 00086 virtual ~MSSourceIndex(); 00087 00088 MSSourceIndex &operator=(const MSSourceIndex &other); 00089 00090 void attach(const MSSource &source); 00091 00092 // access to the source ID key, throws an exception if isNull() is False 00093 Int &sourceId() {return *sourceId_p;} 00094 00095 // access to the spectral window ID key, throws an 00096 // exception if isNull() is False 00097 Int &spectralWindowId() {return *spwId_p;} 00098 00099 // Match a source name or list of source names to a set of SOURCE_ID's 00100 Vector<Int> matchSourceName(const String& name); 00101 Vector<Int> matchSourceName(const Vector<String>& names); 00102 00103 //add for source code selection 00104 Vector<Int> matchSourceCode(const String& code); 00105 00106 //Return rows matching a SourceID 00107 Vector<uInt> getRowNumbersOfSourceID(const Int sid); 00108 00109 00110 protected: 00111 // the specialized compare function to pass to the 00112 // <linkto class=ColumnsIndex>ColumnsIndex</linkto> object. This supports -1 00113 // values for the SPECTRAL_WINDOW_ID 00114 static Int compare (const Block<void*>& fieldPtrs, 00115 const Block<void*>& dataPtrs, 00116 const Block<Int>& dataTypes, 00117 Int index); 00118 00119 private: 00120 // Pointer to local ROMSSourceColumns object 00121 ROMSSourceColumns* msSourceCols_p; 00122 00123 RecordFieldPtr<Int> sourceId_p, spwId_p; 00124 00125 void attachIds(); 00126 00127 }; 00128 00129 00130 } //# NAMESPACE CASACORE - END 00131 00132 #endif 00133