Frequency.h

Go to the documentation of this file.

//Frequency.h generated on 'Thu Feb 04 10:20:05 CET 2010'. Edit at your own risk.
/*
 * ALMA - Atacama Large Millimeter Array
 * (c) European Southern Observatory, 2002
 * (c) Associated Universities Inc., 2002
 * Copyright by ESO (in the framework of the ALMA collaboration),
 * Copyright by AUI (in the framework of the ALMA collaboration),
 * All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307  USA
 *
 * File Frequency.h
 */
#ifndef Frequency_CLASS
#define Frequency_CLASS
#include <vector>
#include <iostream>
#include <string>
#ifndef WITHOUT_ACS
#include <asdmIDLTypesC.h>
#endif
#include <alma/ASDM/StringTokenizer.h>
#include <alma/ASDM/NumberFormatException.h>
#include <alma/ASDM/EndianStream.h>
namespace asdm {
class Frequency;
Frequency operator * ( double , const Frequency & );
std::ostream & operator << ( std::ostream &, const Frequency & );
std::istream & operator >> ( std::istream &, Frequency &);
class Frequency {
  friend Frequency operator * ( double d, const Frequency & x );
  friend std::ostream & operator << ( std::ostream & os, const Frequency & x);
  friend std::istream & operator >> ( std::istream & is, Frequency & x);
public:
        Frequency();
        Frequency(const Frequency &);
        Frequency(const std::string &s);
#ifndef WITHOUT_ACS

        Frequency(const asdmIDLTypes::IDLFrequency & idlFrequency);
#endif

        Frequency(double value);
        virtual ~Frequency();
        static double fromString(const std::string& s);
        static std::string toString(double);
        static Frequency getFrequency(StringTokenizer &st) throw(NumberFormatException);
                        
        void toBin(EndianOSStream& eoss);
        static void toBin(const std::vector<Frequency>& angle,  EndianOSStream& eoss);
        
        static void toBin(const std::vector<std::vector<Frequency> >& angle,  EndianOSStream& eoss);
        
        static void toBin(const std::vector<std::vector<std::vector<Frequency> > >& angle,  EndianOSStream& eoss);
        static Frequency fromBin(EndianIStream& eis);
        
         static std::vector<Frequency> from1DBin(EndianIStream & eis);
         
         static std::vector<std::vector<Frequency> > from2DBin(EndianIStream & eis);
         
         static std::vector<std::vector<std::vector<Frequency> > > from3DBin(EndianIStream & eis);       
         
         Frequency & operator = (const Frequency & x);
         
         Frequency & operator = (const double d);
        Frequency & operator += (const Frequency & x);
        Frequency & operator -= (const Frequency & x);
        Frequency & operator *= (const double x);
        Frequency & operator /= (const double x);
        Frequency operator + (const Frequency & x) const;
        Frequency operator - (const Frequency & x) const;
        Frequency operator * (const double x) const;
        Frequency operator / (const double x) const;
        bool operator < (const Frequency & x) const;
        bool operator > (const Frequency & x) const;
        bool operator <= (const Frequency & x) const;
        bool operator >= (const Frequency & x) const;
        bool operator == (const Frequency & x) const;
        bool equals(const Frequency & x) const;
        bool operator != (const Frequency & x) const;
        bool isZero() const;
        Frequency operator - () const;
        Frequency operator + () const;
        std::string toString() const;
        std::string toStringI() const;
        operator std::string () const;
        double get() const;
#ifndef WITHOUT_ACS

    asdmIDLTypes::IDLFrequency toIDLFrequency() const;
#endif

        static std::string unit();
private:
        double value;
};
// Frequency constructors
inline Frequency::Frequency() : value(0.0) {
}
inline Frequency::Frequency(const Frequency &t) : value(t.value) {
}
#ifndef WITHOUT_ACS
inline Frequency::Frequency(const asdmIDLTypes::IDLFrequency &l) : value(l.value) {
}
#endif
inline Frequency::Frequency(const std::string &s) : value(fromString(s)) {
}
inline Frequency::Frequency(double v) : value(v) {
}
// Frequency destructor
inline Frequency::~Frequency() { }
// assignment operator
inline Frequency & Frequency::operator = ( const Frequency &t ) {
        value = t.value;
        return *this;
}
// assignment operator
inline Frequency & Frequency::operator = ( const double v ) {
        value = v;
        return *this;
}
// assignment with arithmetic operators
inline Frequency & Frequency::operator += ( const Frequency & t) {
        value += t.value;
        return *this;
}
inline Frequency & Frequency::operator -= ( const Frequency & t) {
        value -= t.value;
        return *this;
}
inline Frequency & Frequency::operator *= ( const double n) {
        value *= n;
        return *this;
}
inline Frequency & Frequency::operator /= ( const double n) {
        value /= n;
        return *this;
}
// arithmetic functions
inline Frequency Frequency::operator + ( const Frequency &t2 ) const {
        Frequency tmp;
        tmp.value = value + t2.value;
        return tmp;
}
inline Frequency Frequency::operator - ( const Frequency &t2 ) const {
        Frequency tmp;
        tmp.value = value - t2.value;
        return tmp;
}
inline Frequency Frequency::operator * ( const double n) const {
        Frequency tmp;
        tmp.value = value * n;
        return tmp;
}
inline Frequency Frequency::operator / ( const double n) const {
        Frequency tmp;
        tmp.value = value / n;
        return tmp;
}
// comparison operators
inline bool Frequency::operator < (const Frequency & x) const {
        return (value < x.value);
}
inline bool Frequency::operator > (const Frequency & x) const {
        return (value > x.value);
}
inline bool Frequency::operator <= (const Frequency & x) const {
        return (value <= x.value);
}
inline bool Frequency::operator >= (const Frequency & x) const {
        return (value >= x.value);
}
inline bool Frequency::equals(const Frequency & x) const {
        return (value == x.value);
}
inline bool Frequency::operator == (const Frequency & x) const {
        return (value == x.value);
}
inline bool Frequency::operator != (const Frequency & x) const {
        return (value != x.value);
}
// unary - and + operators
inline Frequency Frequency::operator - () const {
        Frequency tmp;
        tmp.value = -value;
        return tmp;
}
inline Frequency Frequency::operator + () const {
        Frequency tmp;
    tmp.value = value;
        return tmp;
}
// Conversion functions
inline Frequency::operator std::string () const {
        return toString();
}
inline std::string Frequency::toString() const {
        return toString(value);
}
inline std::string Frequency::toStringI() const {
        return toString(value);
}
inline double Frequency::get() const {
        return value;
}
#ifndef WITHOUT_ACS
inline asdmIDLTypes::IDLFrequency Frequency::toIDLFrequency() const {
    asdmIDLTypes::IDLFrequency tmp;
        tmp.value = value;
        return tmp;
}
#endif
// Friend functions
inline Frequency operator * ( double n, const Frequency &x) {
        Frequency tmp;
        tmp.value = x.value * n;
        return tmp;
}
inline std::ostream & operator << ( std::ostream &o, const Frequency &x ) {
        o << x.value;
        return o;
}
inline std::istream & operator >> ( std::istream &i, Frequency &x ) {
        i >> x.value;
        return i;
}
inline std::string Frequency::unit() {
        return std::string ("Hz");
}
} // End namespace asdm
#endif /* Frequency_CLASS */