File: NullablePredictionValue.hh

package info (click to toggle)
xtide 2.9.5-3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 2,996 kB
  • ctags: 2,141
  • sloc: cpp: 20,379; sh: 1,044; makefile: 224; yacc: 114; lex: 58
file content (52 lines) | stat: -rw-r--r-- 2,064 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
// $Id: NullablePredictionValue.hh 2641 2007-09-02 21:31:02Z flaterco $

// NullablePredictionValue:  strict nullable PredictionValue.

/*
    Copyright (C) 2006  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/>.
*/

// If not null, an implicit conversion to PredictionValue is available.

class NullablePredictionValue: public Nullable {
public:
  NullablePredictionValue ();                               // Makes a null.
  NullablePredictionValue (PredictionValue pv);             // Not null.
  NullablePredictionValue (Units::PredictionUnits units,    // Not null.
                           double value);

  const double val() const;                     // Error if null.
  void Units (Units::PredictionUnits units);    // Error if null.
  const Units::PredictionUnits Units () const;  // Error if null.

  // Let int types be implicitly converted to double.
  void operator*= (double multiplier);          // Error if null.
  void operator/= (double divisor);             // Error if null.

  // Like += except that conversions are silently performed.
  // Use only when you really mean it.
  void convertAndAdd (PredictionValue addend);  // Error if null.

  // Print in the form -XX.YY units (padding as needed).  Error if null.
  void print (Dstr &text_out) const;
  // Same thing without padding, with abbreviated units.  Error if null.
  void printnp (Dstr &text_out) const;

protected:
  PredictionValue _pv;
};

// Cleanup2006 Done