casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Length.h
Go to the documentation of this file.
1 //Length.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 Length.h
26  */
27 #ifndef Length_CLASS
28 #define Length_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 Length;
40 Length operator * ( double , const Length & );
41 std::ostream & operator << ( std::ostream &, const Length & );
42 std::istream & operator >> ( std::istream &, Length &);
53 class Length {
60  friend Length operator * ( double d, const Length & x );
66  friend std::ostream & operator << ( std::ostream & os, const Length & x);
70  friend std::istream & operator >> ( std::istream & is, Length & x);
71 public:
75  Length();
79  Length(const Length &);
87  Length(const std::string &s);
88 #ifndef WITHOUT_ACS
89 
95  Length(const asdmIDLTypes::IDLLength & idlLength);
96 #endif
97 
101  Length(double value);
105  virtual ~Length();
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<Length>& angle, EndianOSStream& eoss);
136 
142  static void toBin(const std::vector<std::vector<Length> >& angle, EndianOSStream& eoss);
143 
149  static void toBin(const std::vector<std::vector<std::vector<Length> > >& angle, EndianOSStream& eoss);
156  static Length fromBin(EndianIStream& eis);
157 
164  static std::vector<Length> from1DBin(EndianIStream & eis);
165 
172  static std::vector<std::vector<Length> > from2DBin(EndianIStream & eis);
173 
180  static std::vector<std::vector<std::vector<Length> > > from3DBin(EndianIStream & eis);
181 
186  Length & operator = (const Length & x);
187 
192  Length & operator = (const double d);
197  Length & operator += (const Length & x);
202  Length & operator -= (const Length & x);
207  Length & operator *= (const double x);
212  Length & operator /= (const double x);
217  Length operator + (const Length & x) const;
222  Length operator - (const Length & x) const;
227  Length operator * (const double x) const;
232  Length operator / (const double x) const;
237  bool operator < (const Length & x) const;
242  bool operator > (const Length & x) const;
247  bool operator <= (const Length & x) const;
252  bool operator >= (const Length & x) const;
257  bool operator == (const Length & x) const;
262  bool equals(const Length & x) const;
267  bool operator != (const Length & x) const;
272  bool isZero() const;
276  Length operator - () const;
280  Length 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::IDLLength toIDLLength() const;
306 #endif
307 
311  static std::string unit();
312 private:
313  double value;
314 };
315 // Length constructors
316 inline Length::Length() : value(0.0) {
317 }
318 inline Length::Length(const Length &t) : value(t.value) {
319 }
320 #ifndef WITHOUT_ACS
321 inline Length::Length(const asdmIDLTypes::IDLLength &l) : value(l.value) {
322 }
323 #endif
324 inline Length::Length(const std::string &s) : value(fromString(s)) {
325 }
326 inline Length::Length(double v) : value(v) {
327 }
328 // Length destructor
329 inline Length::~Length() { }
330 // assignment operator
331 inline Length & Length::operator = ( const Length &t ) {
332  value = t.value;
333  return *this;
334 }
335 // assignment operator
336 inline Length & Length::operator = ( const double v ) {
337  value = v;
338  return *this;
339 }
340 // assignment with arithmetic operators
341 inline Length & Length::operator += ( const Length & t) {
342  value += t.value;
343  return *this;
344 }
345 inline Length & Length::operator -= ( const Length & t) {
346  value -= t.value;
347  return *this;
348 }
349 inline Length & Length::operator *= ( const double n) {
350  value *= n;
351  return *this;
352 }
353 inline Length & Length::operator /= ( const double n) {
354  value /= n;
355  return *this;
356 }
357 // arithmetic functions
358 inline Length Length::operator + ( const Length &t2 ) const {
359  Length tmp;
360  tmp.value = value + t2.value;
361  return tmp;
362 }
363 inline Length Length::operator - ( const Length &t2 ) const {
364  Length tmp;
365  tmp.value = value - t2.value;
366  return tmp;
367 }
368 inline Length Length::operator * ( const double n) const {
369  Length tmp;
370  tmp.value = value * n;
371  return tmp;
372 }
373 inline Length Length::operator / ( const double n) const {
374  Length tmp;
375  tmp.value = value / n;
376  return tmp;
377 }
378 // comparison operators
379 inline bool Length::operator < (const Length & x) const {
380  return (value < x.value);
381 }
382 inline bool Length::operator > (const Length & x) const {
383  return (value > x.value);
384 }
385 inline bool Length::operator <= (const Length & x) const {
386  return (value <= x.value);
387 }
388 inline bool Length::operator >= (const Length & x) const {
389  return (value >= x.value);
390 }
391 inline bool Length::equals(const Length & x) const {
392  return (value == x.value);
393 }
394 inline bool Length::operator == (const Length & x) const {
395  return (value == x.value);
396 }
397 inline bool Length::operator != (const Length & x) const {
398  return (value != x.value);
399 }
400 // unary - and + operators
401 inline Length Length::operator - () const {
402  Length tmp;
403  tmp.value = -value;
404  return tmp;
405 }
406 inline Length Length::operator + () const {
407  Length tmp;
408  tmp.value = value;
409  return tmp;
410 }
411 // Conversion functions
412 inline Length::operator std::string () const {
413  return toString();
414 }
415 inline std::string Length::toString() const {
416  return toString(value);
417 }
418 inline std::string Length::toStringI() const {
419  return toString(value);
420 }
421 inline double Length::get() const {
422  return value;
423 }
424 #ifndef WITHOUT_ACS
425 inline asdmIDLTypes::IDLLength Length::toIDLLength() const {
426  asdmIDLTypes::IDLLength tmp;
427  tmp.value = value;
428  return tmp;
429 }
430 #endif
431 // Friend functions
432 inline Length operator * ( double n, const Length &x) {
433  Length tmp;
434  tmp.value = x.value * n;
435  return tmp;
436 }
437 inline std::ostream & operator << ( std::ostream &o, const Length &x ) {
438  o << x.value;
439  return o;
440 }
441 inline std::istream & operator >> ( std::istream &i, Length &x ) {
442  i >> x.value;
443  return i;
444 }
445 inline std::string Length::unit() {
446  return std::string ("m");
447 }
448 } // End namespace asdm
449 #endif /* Length_CLASS */
static std::vector< std::vector< Length > > from2DBin(EndianIStream &eis)
Read the binary representation of a vector of vector of Length from an EndianIStream and use the read...
double value
Definition: Length.h:313
Length & operator=(const Length &x)
An assignment operator Length = Length.
Definition: Length.h:331
Length & operator+=(const Length &x)
Operator increment and assign.
Definition: Length.h:341
static Length fromBin(EndianIStream &eis)
Read the binary representation of an Length from a EndianIStream and use the read value to set an Len...
bool operator>=(const Length &x) const
Comparison operator.
Definition: Length.h:388
Length & operator*=(const double x)
Operator multiply and assign.
Definition: Length.h:349
double get() const
Return the double precision value of the Length.
Definition: Length.h:421
static std::string unit()
Returns the abbreviated name of the unit implicitely associated to any Length.
Definition: Length.h:445
std::istream & operator>>(std::istream &, EntityId &)
Definition: EntityId.h:164
The StringTokenizer class is a translation into C++ of the Java class of the same name in Java&#39;s util...
bool operator==(const Length &x) const
Comparision operator.
Definition: Length.h:394
static double fromString(const std::string &s)
A static method equivalent to the constructor from a string.
bool operator!=(const Length &x) const
Comparison operator.
Definition: Length.h:397
The NumberFormatException class represents an exception when an error occurs in converting a numeric ...
Length operator*(double, const Length &)
Friend functions.
Definition: Length.h:432
friend Length operator*(double d, const Length &x)
Overloading of multiplication operator.
void toBin(EndianOSStream &eoss)
Write the binary representation of this to an EndianOSStream .
friend std::ostream & operator<<(std::ostream &os, const Length &x)
Overloading of &lt;&lt; to output the value an Length on an ostream.
bool operator<(const Length &x) const
Comparison operator.
Definition: Length.h:379
bool operator<=(const Length &x) const
Comparison operator.
Definition: Length.h:385
std::string toStringI() const
Idem toString.
Definition: Length.h:418
static std::vector< std::vector< std::vector< Length > > > from3DBin(EndianIStream &eis)
Read the binary representation of a vector of vector of vector of Length from an EndianIStream and us...
std::string toString() const
Converts into a string.
Definition: Length.h:415
std::ostream & operator<<(std::ostream &, const EntityId &)
Friend functions.
Definition: EntityId.h:159
casacore::String toString(VisibilityProcessor::ProcessingType p)
friend std::istream & operator>>(std::istream &is, Length &x)
Overloading of &gt;&gt; to read an Length from an istream.
Length & operator/=(const double x)
Operator divide and assign.
Definition: Length.h:353
The Length class implements a quantity of length in meters.
Definition: Length.h:53
Length & operator-=(const Length &x)
Operator decrement and assign.
Definition: Length.h:345
asdmIDLTypes::IDLLength toIDLLength() const
Return the IDLLength representation of the Length.
Definition: Length.h:425
Length operator/(const double x) const
Division operator.
Definition: Length.h:373
bool equals(const Length &x) const
Comparison method.
Definition: Length.h:391
Length operator+() const
Unary operator.
Definition: Length.h:406
bool isZero() const
Comparison method.
static Length getLength(StringTokenizer &st)
Parse the next (string) token of a StringTokenizer into an angle.
virtual ~Length()
The destructor.
Definition: Length.h:329
Class for those physical parameters having dimensions of Length [L].
Definition: ATMLength.h:44
Length operator-() const
Unary operator.
Definition: Length.h:401
static std::vector< Length > from1DBin(EndianIStream &eis)
Read the binary representation of a vector of Length from an EndianIStream and use the read value to ...
LatticeExprNode value(const LatticeExprNode &expr)
This function returns the value of the expression without a mask.
bool operator>(const Length &x) const
Comparison operator.
Definition: Length.h:382
Length()
The nullary constructor (default).
Definition: Length.h:316