File: StationIndex.hh

package info (click to toggle)
xtide 2.13.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 3,348 kB
  • ctags: 2,350
  • sloc: cpp: 23,919; sh: 1,319; makefile: 224; yacc: 114; lex: 58; xml: 2
file content (83 lines) | stat: -rw-r--r-- 3,183 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// $Id: StationIndex.hh 2641 2007-09-02 21:31:02Z flaterco $

/*  StationIndex  Collection of StationRefs.

    Copyright (C) 1998  David Flater.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/


// "STL containers are not intended to be used as base classes (their
// destructors are deliberately non-virtual).  Deriving from a
// container is a common mistake made by novices."
// -- Standard Template Library,
// http://en.wikipedia.org/w/index.php?title=Standard_Template_Library&oldid=98705028
// (last visited January 13, 2007).

// It's not const StationRef* because setRootStationIndexIndices() has
// to work.
class StationIndex: public SafeVector<StationRef*> {
public:

  // Import refs for all stations in the specified harmonics file.
  void addHarmonicsFile (const Dstr &harmonicsFileName);

  // This is a front end to std::sort that uses the comparison
  // functions declared in StationRef.hh.
  enum SortKey {sortByName, sortByLat, sortByLng};
  void sort (SortKey sortKey = StationIndex::sortByName);

  // QueryType refers to the applicable Dstr operation, %= or
  // contains.  Selected station refs are added to index (any refs
  // already in there are unchanged).
  enum QueryType {percentEqual, contains};
  void query (const Dstr &pattern,
              StationIndex &index,
              QueryType queryType) const;

  // This implements list mode.
  enum WebListStyle {xttpdStyle, normalStyle};
  void print (Dstr &text_out,
              Format::Format form,
              WebListStyle style = normalStyle) const;

  // Construct array of character strings used by xxLocationList.
  char **makeStringList (unsigned long startAt,
                         unsigned long maxLength) const;

  // Return identifiers for imported harmonics files in HTML format.
  void hfileIDs (Dstr &hfileIDs_out);

  // Find a station by %= name, with UTF-8 / Latin-1 conversion as
  // needed.  Return NULL if not found.
  StationRef * const getStationRefByName (const Dstr &name) const;

  // Return longitude with the most stations.
  const double bestCenterLongitude() const;

  // xttpd needs StationRef::rootStationIndexIndex to be set on all
  // station refs.  This method sets those fields in all station refs
  // in the current index.  It should be called on the root
  // StationIndex after all harmonics files have been indexed.
  void setRootStationIndexIndices();

protected:
  Dstr _hfileIDs;

  // Without locale correction.  Return NULL if not found.
  StationRef * const getStationRefByLatin1Name (const Dstr &name) const;
};

// Cleanup2006 Done