casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Humidity.h
Go to the documentation of this file.
1 //Humidity.h generated on 'Thu Feb 04 10:20:05 CET 2010'. Edit at your own risk.
2 /*
3  * ALMA - Atacama Large Millimeter Array
4  * (c) European Southern Observatory, 2002
5  * (c) Associated Universities Inc., 2002
6  * Copyright by ESO (in the framework of the ALMA collaboration),
7  * Copyright by AUI (in the framework of the ALMA collaboration),
8  * All rights reserved.
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY, without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this library; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23  * MA 02111-1307 USA
24  *
25  * File Humidity.h
26  */
27 #ifndef Humidity_CLASS
28 #define Humidity_CLASS
29 #include <vector>
30 #include <iostream>
31 #include <string>
32 #ifndef WITHOUT_ACS
33 #include <asdmIDLTypesC.h>
34 #endif
37 #include <alma/ASDM/EndianStream.h>
38 namespace asdm {
39 class Humidity;
40 Humidity operator * ( double , const Humidity & );
41 std::ostream & operator << ( std::ostream &, const Humidity & );
42 std::istream & operator >> ( std::istream &, Humidity &);
53 class Humidity {
60  friend Humidity operator * ( double d, const Humidity & x );
66  friend std::ostream & operator << ( std::ostream & os, const Humidity & x);
70  friend std::istream & operator >> ( std::istream & is, Humidity & x);
71 public:
75  Humidity();
79  Humidity(const Humidity &);
87  Humidity(const std::string &s);
88 #ifndef WITHOUT_ACS
89 
95  Humidity(const asdmIDLTypes::IDLHumidity & idlHumidity);
96 #endif
97 
101  Humidity(double value);
105  virtual ~Humidity();
110  static double fromString(const std::string& s);
117  static std::string toString(double);
124 
129  void toBin(EndianOSStream& eoss);
135  static void toBin(const std::vector<Humidity>& angle, EndianOSStream& eoss);
136 
142  static void toBin(const std::vector<std::vector<Humidity> >& angle, EndianOSStream& eoss);
143 
149  static void toBin(const std::vector<std::vector<std::vector<Humidity> > >& angle, EndianOSStream& eoss);
156  static Humidity fromBin(EndianIStream& eis);
157 
164  static std::vector<Humidity> from1DBin(EndianIStream & eis);
165 
172  static std::vector<std::vector<Humidity> > from2DBin(EndianIStream & eis);
173 
180  static std::vector<std::vector<std::vector<Humidity> > > from3DBin(EndianIStream & eis);
181 
186  Humidity & operator = (const Humidity & x);
187 
192  Humidity & operator = (const double d);
197  Humidity & operator += (const Humidity & x);
202  Humidity & operator -= (const Humidity & x);
207  Humidity & operator *= (const double x);
212  Humidity & operator /= (const double x);
217  Humidity operator + (const Humidity & x) const;
222  Humidity operator - (const Humidity & x) const;
227  Humidity operator * (const double x) const;
232  Humidity operator / (const double x) const;
237  bool operator < (const Humidity & x) const;
242  bool operator > (const Humidity & x) const;
247  bool operator <= (const Humidity & x) const;
252  bool operator >= (const Humidity & x) const;
257  bool operator == (const Humidity & x) const;
262  bool equals(const Humidity & x) const;
267  bool operator != (const Humidity & x) const;
272  bool isZero() const;
276  Humidity operator - () const;
280  Humidity operator + () const;
285  std::string toString() const;
289  std::string toStringI() const;
294  operator std::string () const;
299  double get() const;
300 #ifndef WITHOUT_ACS
301 
305  asdmIDLTypes::IDLHumidity toIDLHumidity() const;
306 #endif
307 
311  static std::string unit();
312 private:
313  double value;
314 };
315 // Humidity constructors
316 inline Humidity::Humidity() : value(0.0) {
317 }
318 inline Humidity::Humidity(const Humidity &t) : value(t.value) {
319 }
320 #ifndef WITHOUT_ACS
321 inline Humidity::Humidity(const asdmIDLTypes::IDLHumidity &l) : value(l.value) {
322 }
323 #endif
324 inline Humidity::Humidity(const std::string &s) : value(fromString(s)) {
325 }
326 inline Humidity::Humidity(double v) : value(v) {
327 }
328 // Humidity destructor
330 // assignment operator
332  value = t.value;
333  return *this;
334 }
335 // assignment operator
336 inline Humidity & Humidity::operator = ( const double v ) {
337  value = v;
338  return *this;
339 }
340 // assignment with arithmetic operators
342  value += t.value;
343  return *this;
344 }
346  value -= t.value;
347  return *this;
348 }
349 inline Humidity & Humidity::operator *= ( const double n) {
350  value *= n;
351  return *this;
352 }
353 inline Humidity & Humidity::operator /= ( const double n) {
354  value /= n;
355  return *this;
356 }
357 // arithmetic functions
358 inline Humidity Humidity::operator + ( const Humidity &t2 ) const {
359  Humidity tmp;
360  tmp.value = value + t2.value;
361  return tmp;
362 }
363 inline Humidity Humidity::operator - ( const Humidity &t2 ) const {
364  Humidity tmp;
365  tmp.value = value - t2.value;
366  return tmp;
367 }
368 inline Humidity Humidity::operator * ( const double n) const {
369  Humidity tmp;
370  tmp.value = value * n;
371  return tmp;
372 }
373 inline Humidity Humidity::operator / ( const double n) const {
374  Humidity tmp;
375  tmp.value = value / n;
376  return tmp;
377 }
378 // comparison operators
379 inline bool Humidity::operator < (const Humidity & x) const {
380  return (value < x.value);
381 }
382 inline bool Humidity::operator > (const Humidity & x) const {
383  return (value > x.value);
384 }
385 inline bool Humidity::operator <= (const Humidity & x) const {
386  return (value <= x.value);
387 }
388 inline bool Humidity::operator >= (const Humidity & x) const {
389  return (value >= x.value);
390 }
391 inline bool Humidity::equals(const Humidity & x) const {
392  return (value == x.value);
393 }
394 inline bool Humidity::operator == (const Humidity & x) const {
395  return (value == x.value);
396 }
397 inline bool Humidity::operator != (const Humidity & x) const {
398  return (value != x.value);
399 }
400 // unary - and + operators
402  Humidity tmp;
403  tmp.value = -value;
404  return tmp;
405 }
407  Humidity tmp;
408  tmp.value = value;
409  return tmp;
410 }
411 // Conversion functions
412 inline Humidity::operator std::string () const {
413  return toString();
414 }
415 inline std::string Humidity::toString() const {
416  return toString(value);
417 }
418 inline std::string Humidity::toStringI() const {
419  return toString(value);
420 }
421 inline double Humidity::get() const {
422  return value;
423 }
424 #ifndef WITHOUT_ACS
425 inline asdmIDLTypes::IDLHumidity Humidity::toIDLHumidity() const {
426  asdmIDLTypes::IDLHumidity tmp;
427  tmp.value = value;
428  return tmp;
429 }
430 #endif
431 // Friend functions
432 inline Humidity operator * ( double n, const Humidity &x) {
433  Humidity tmp;
434  tmp.value = x.value * n;
435  return tmp;
436 }
437 inline std::ostream & operator << ( std::ostream &o, const Humidity &x ) {
438  o << x.value;
439  return o;
440 }
441 inline std::istream & operator >> ( std::istream &i, Humidity &x ) {
442  i >> x.value;
443  return i;
444 }
445 inline std::string Humidity::unit() {
446  return std::string ("%");
447 }
448 } // End namespace asdm
449 #endif /* Humidity_CLASS */
bool operator!=(const Humidity &x) const
Comparison operator.
Definition: Humidity.h:397
void toBin(EndianOSStream &eoss)
Write the binary representation of this to an EndianOSStream .
static std::string unit()
Returns the abbreviated name of the unit implicitely associated to any Humidity.
Definition: Humidity.h:445
Humidity & operator+=(const Humidity &x)
Operator increment and assign.
Definition: Humidity.h:341
friend std::istream & operator>>(std::istream &is, Humidity &x)
Overloading of &gt;&gt; to read an Humidity from an istream.
Humidity & operator=(const Humidity &x)
An assignment operator Humidity = Humidity.
Definition: Humidity.h:331
bool operator<(const Humidity &x) const
Comparison operator.
Definition: Humidity.h:379
ATM_NAMESPACE_BEGIN typedef ATM_NAMESPACE::Percent Humidity
Definition: ATMHumidity.h:37
virtual ~Humidity()
The destructor.
Definition: Humidity.h:329
std::istream & operator>>(std::istream &, EntityId &)
Definition: EntityId.h:164
static std::vector< std::vector< Humidity > > from2DBin(EndianIStream &eis)
Read the binary representation of a vector of vector of Humidity from an EndianIStream and use the re...
bool operator>(const Humidity &x) const
Comparison operator.
Definition: Humidity.h:382
std::string toString() const
Converts into a string.
Definition: Humidity.h:415
The StringTokenizer class is a translation into C++ of the Java class of the same name in Java&#39;s util...
double get() const
Return the double precision value of the Humidity.
Definition: Humidity.h:421
Humidity & operator/=(const double x)
Operator divide and assign.
Definition: Humidity.h:353
std::string toStringI() const
Idem toString.
Definition: Humidity.h:418
The Humidity class implements a quantity of humidity in percent.
Definition: Humidity.h:53
Humidity()
The nullary constructor (default).
Definition: Humidity.h:316
bool isZero() const
Comparison method.
The NumberFormatException class represents an exception when an error occurs in converting a numeric ...
bool equals(const Humidity &x) const
Comparison method.
Definition: Humidity.h:391
Length operator*(double, const Length &)
Friend functions.
Definition: Length.h:432
Humidity operator-() const
Unary operator.
Definition: Humidity.h:401
bool operator<=(const Humidity &x) const
Comparison operator.
Definition: Humidity.h:385
static Humidity getHumidity(StringTokenizer &st)
Parse the next (string) token of a StringTokenizer into an angle.
asdmIDLTypes::IDLHumidity toIDLHumidity() const
Return the IDLHumidity representation of the Humidity.
Definition: Humidity.h:425
std::ostream & operator<<(std::ostream &, const EntityId &)
Friend functions.
Definition: EntityId.h:159
static Humidity fromBin(EndianIStream &eis)
Read the binary representation of an Humidity from a EndianIStream and use the read value to set an H...
casacore::String toString(VisibilityProcessor::ProcessingType p)
friend std::ostream & operator<<(std::ostream &os, const Humidity &x)
Overloading of &lt;&lt; to output the value an Humidity on an ostream.
static std::vector< Humidity > from1DBin(EndianIStream &eis)
Read the binary representation of a vector of Humidity from an EndianIStream and use the read value t...
Humidity operator/(const double x) const
Division operator.
Definition: Humidity.h:373
bool operator==(const Humidity &x) const
Comparision operator.
Definition: Humidity.h:394
bool operator>=(const Humidity &x) const
Comparison operator.
Definition: Humidity.h:388
Humidity operator+() const
Unary operator.
Definition: Humidity.h:406
friend Humidity operator*(double d, const Humidity &x)
Overloading of multiplication operator.
Humidity & operator*=(const double x)
Operator multiply and assign.
Definition: Humidity.h:349
static double fromString(const std::string &s)
A static method equivalent to the constructor from a string.
static std::vector< std::vector< std::vector< Humidity > > > from3DBin(EndianIStream &eis)
Read the binary representation of a vector of vector of vector of Humidity from an EndianIStream and ...
double value
Definition: Humidity.h:313
Humidity & operator-=(const Humidity &x)
Operator decrement and assign.
Definition: Humidity.h:345
LatticeExprNode value(const LatticeExprNode &expr)
This function returns the value of the expression without a mask.