ComplexWrapper.h

Go to the documentation of this file.

/*
 * 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 Complex.h
 */

#ifndef Complex_CLASS
#define Complex_CLASS

#include <vector>
#include <complex>
#include <iostream>
#include <string>

#ifndef WITHOUT_ACS
#include <asdmIDLTypesC.h>
#endif

#include <alma/ASDM/DoubleWrapper.h>
#include <alma/ASDM/StringTokenizer.h>
#include <alma/ASDM/NumberFormatException.h>

#include <alma/ASDM/EndianStream.h>

namespace asdm {

class Complex : public std::complex<double> {

public:
        static Complex fromString(const std::string&) throw(NumberFormatException);
        static std::string toString(const Complex&);
        static Complex getComplex(StringTokenizer &t) throw(NumberFormatException);

        Complex();                                              // default constructor
        Complex(const Complex &);                                               // X const X& constructor
        Complex(const std::string &s);
#ifndef WITHOUT_ACS
        Complex(const asdmIDLTypes::IDLComplex &);
#endif
        Complex(double re, double im);

        double getReal() const;
        double getImg() const;
        void setReal(double re);
        void setImg(double im);

        bool isZero() const;
        bool equals(const Complex &) const;

        std::string toString() const;
#ifndef WITHOUT_ACS
    asdmIDLTypes::IDLComplex toIDLComplex() const;
#endif

        void toBin(EndianOSStream& eoss);

        static void toBin(const std::vector<Complex>& cmplx,  EndianOSStream& eoss);
        
        static void toBin(const std::vector<std::vector<Complex> >& cmplx,  EndianOSStream& eoss);
        
        static void toBin(const std::vector<std::vector<std::vector<Complex> > >& cmplx,  EndianOSStream& eoss);

        static Complex fromBin(EndianIStream& eis);
        
         static std::vector<Complex> from1DBin(EndianIStream & eis);
         
         static std::vector<std::vector<Complex> > from2DBin(EndianIStream & eis);
         
         static std::vector<std::vector<std::vector<Complex> > > from3DBin(EndianIStream & eis);         

};

// Complex constructors
inline Complex::Complex() : std::complex<double>(0.0,0.0) {
}

inline Complex::Complex(const Complex &t) : std::complex<double>(t.real(),t.imag()) {
}

inline Complex::Complex(const std::string &s) : std::complex<double>(Complex::fromString(s)) {
}

#ifndef WITHOUT_ACS
inline Complex::Complex(const asdmIDLTypes::IDLComplex &l) : std::complex<double>(l.re,l.im) {
}
#endif

inline Complex::Complex(double r, double i) : std::complex<double>(r,i) {
}

inline double Complex::getReal() const {
        return real();
}

inline double Complex::getImg() const {
        return imag();
}

inline void Complex::setReal(double re) {
        *this = Complex(re,imag());
}

inline void Complex::setImg(double im) {
        *this = Complex(real(),im);
}

inline bool Complex::isZero() const {
        return real() == 0.0 && imag() == 0.0;
}

inline bool Complex::equals(const Complex &x) const {
        return real() == x.real() && imag() == x.imag();
}

#ifndef WITHOUT_ACS
inline asdmIDLTypes::IDLComplex Complex::toIDLComplex() const {
    asdmIDLTypes::IDLComplex x;
        x.re = getReal();
        x.im = getImg();
        return x;
}
#endif

inline std::string Complex::toString() const {
        return Double::toString(getReal()) + " " + Double::toString(getImg());
}

} // End namespace asdm

#endif /* Complex_CLASS */