casacore
TabPath.h
Go to the documentation of this file.
1 //# TabPath.h: Search path for table files
2 //# Copyright (C) 1993,1994,1995
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 TABLES_TABPATH_H
29 #define TABLES_TABPATH_H
30 
31 //# Includes
32 #include <casacore/casa/aips.h>
33 #include <casacore/casa/BasicSL/String.h>
34 #include <casacore/casa/Containers/Block.h>
35 
36 
37 namespace casacore { //# NAMESPACE CASACORE - BEGIN
38 
39 // <summary>
40 // Search path for table files
41 // </summary>
42 
43 // <use visibility=local>
44 
45 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
46 // </reviewed>
47 
48 // <prerequisite>
49 // </prerequisite>
50 
51 // <synopsis>
52 // TabPath is the class containing the search path for table files.
53 // It is used by the TabDesc class to find the directory of a table
54 // description.
55 // </synopsis>
56 
57 // <todo asof="$DATE:$">
58 // <li> This class has to be replaced by a more general path class.
59 // </todo>
60 
61 
62 class TabPath
63 {
64 public:
65  // Create a table file search path with a .COD{Directory}
66  // Use default path ., ~/TabDir
67  TabPath ();
68 
69  // Create a table file search path with given path name.
70  TabPath (const String&);
71 
72  // Remove a table file search path.
74 
75  // Find a file in one of the directories.
76  Bool found (const String&, String&) const;
77 
78  // Get the directory name.
79  const String& dir (uInt dirnr) const;
80 
81 private:
82  Block<String> tabDir_p; // file directories
83  uInt nrDir_p; // # directories
84 };
85 
86 
87 
88 } //# NAMESPACE CASACORE - END
89 
90 #endif
simple 1-D array
Definition: Block.h:200
String: the storage and methods of handling collections of characters.
Definition: String.h:225
const String & dir(uInt dirnr) const
Get the directory name.
Block< String > tabDir_p
Definition: TabPath.h:82
TabPath(const String &)
Create a table file search path with given path name.
TabPath()
Create a table file search path with a.COD{Directory} Use default path., ~/TabDir.
Bool found(const String &, String &) const
Find a file in one of the directories.
~TabPath()
Remove a table file search path.
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42