RecordExpr.h

Go to the documentation of this file.
00001 //# RecordExpr.h: Global functions to make a expression node for a record field
00002 //# Copyright (C) 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 //# $Id$
00027 
00028 #ifndef TABLES_RECORDEXPR_H
00029 #define TABLES_RECORDEXPR_H
00030 
00031 //# Includes
00032 #include <casacore/casa/aips.h>
00033 #include <casacore/tables/TaQL/ExprNode.h>
00034 #include <casacore/casa/Containers/RecordInterface.h>
00035 #include <casacore/casa/Containers/RecordDesc.h>
00036 
00037 
00038 
00039 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00040 
00041 // <summary>
00042 // Global functions to make a expression node for a record field.
00043 // </summary>
00044 
00045 // <use visibility=export>
00046 
00047 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
00048 // </reviewed>
00049 //
00050 // <prerequisite>
00051 //# Classes you should understand before using this one.
00052 //   <li> TableExprNode
00053 // </prerequisite>
00054 
00055 // <synopsis> 
00056 // This file contains a few global functions to construct an expression
00057 // node for a field in a record.
00058 // </synopsis> 
00059 
00060 
00061 // <group name=RecordExpr>
00062 
00063 // Make a record expression node for the given field in the record description.
00064 // <group>
00065 TableExprNode makeRecordExpr (const RecordDesc& desc,
00066                               Int fieldNumber);
00067 TableExprNode makeRecordExpr (const RecordDesc& desc,
00068                               const String& fieldName);
00069 // </group>
00070 
00071 // Make a record expression node for the given field in the record.
00072 inline TableExprNode makeRecordExpr (const RecordInterface& record,
00073                                      Int fieldNumber)
00074     { return makeRecordExpr (record.description(), fieldNumber); }
00075 
00076 
00077 // Make a record expression node for the given field in the record.
00078 // The field can be a field in the record itself, but it can also be
00079 // a field in a subrecord (or subsubrecord, etc.). If it is not a field
00080 // in the record itself, the name must define the 'path' to the field
00081 // in the subrecord by preceeding the field name with the name(s) of the
00082 // subrecord(s) separated by dots. E.g. <src>sub1.sub2.fld</src>
00083 TableExprNode makeRecordExpr (const RecordInterface& record,
00084                               const String& fieldName);
00085 // </group>
00086 
00087 
00088 
00089 
00090 } //# NAMESPACE CASACORE - END
00091 
00092 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1