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

#ifndef Interval_CLASS
#define Interval_CLASS

#include <stdint.h>
#include <vector>
#include <iostream>
#include <string>
using namespace std;

#ifndef WITHOUT_ACS
#include <asdmIDLTypesC.h>
using asdmIDLTypes::IDLInterval;
#endif

#include <StringTokenizer.h>
#include <NumberFormatException.h>
using asdm::StringTokenizer;
using asdm::NumberFormatException;

#include <EndianStream.h>
using asdm::EndianOSStream;
using asdm::EndianISStream;

namespace asdm {

class Interval;
Interval operator * ( int64_t , const Interval & );
ostream & operator << ( ostream &, const Interval & );
istream & operator >> ( istream &, Interval&);

class Interval {
        friend Interval operator * ( int64_t , const Interval & );
    friend ostream & operator << ( ostream &, const Interval & );
        friend istream & operator >> ( istream &, Interval&);

public:
        static int64_t fromString(const string&);
        static string toString(int64_t);
        static Interval getInterval(StringTokenizer &t) throw(NumberFormatException);

        Interval();                                             // default constructor
        Interval(const Interval &);                                             // X const X& constructor
        Interval(const string &s);
#ifndef WITHOUT_ACS
        Interval(const IDLInterval &);
#endif
        Interval(int64_t value);
        virtual ~Interval();                                                    // destructor

        Interval& operator = (const Interval&);                 // assignment operator
        Interval& operator = (const int64_t);                   // assignment operator

        Interval& operator += (const Interval&);                // assignment with arithmetic
        Interval& operator -= (const Interval&);                //      operators
        Interval& operator *= (const int64_t);
        Interval& operator /= (const int64_t);

        Interval operator + (const Interval&) const;    // arithmetic operators
        Interval operator - (const Interval&) const;
        Interval operator * (const int64_t) const;
        Interval operator / (const int64_t) const;

        bool operator < (const Interval&) const;                // comparison operators
        bool operator > (const Interval&) const;
        bool operator <= (const Interval&) const;
        bool operator >= (const Interval&) const;
        bool operator == (const Interval&) const;
        bool equals(const Interval&) const;
        bool operator != (const Interval&) const;

        bool isZero() const;

        Interval operator - () const;                                   // unary minus
        Interval operator + () const;                           // unary plus

        string toString() const;
        string toStringI() const;
        
        void  toBin(EndianOSStream& eoss) ;
        
        static void toBin(vector<Interval> interval, EndianOSStream& eoss) ;
        
        static void toBin(vector<vector<Interval> > interval, EndianOSStream& eoss) ;
        
        static Interval fromBin(EndianISStream& eiss);
        
        static vector<Interval> from1DBin(EndianISStream& eiss);
        
        static vector<vector<Interval> >from2DBin(EndianISStream& eiss);        
        
        operator string () const;
        int64_t get() const;
#ifndef WITHOUT_ACS
        IDLInterval toIDLInterval() const;
#endif
        static string unit();

private:
        int64_t value;

};

// Interval constructors
inline Interval::Interval() : value(0L) {
}

inline Interval::Interval(const Interval &t) : value(t.value) {
}

#ifndef WITHOUT_ACS
inline Interval::Interval(const IDLInterval &l) : value(l.value) {
}
#endif

inline Interval::Interval(const string &s) : value(fromString(s)) {
}

inline Interval::Interval(int64_t v) : value(v) {
}

// Interval destructor
inline Interval::~Interval() { }

// assignment operator
inline Interval& Interval::operator = ( const Interval &t ) {
        value = t.value;
        return *this;
}

// assignment operator
inline Interval& Interval::operator = ( const int64_t v ) {
        value = v;
        return *this;
}

// assignment with arithmetic operators
inline Interval& Interval::operator += ( const Interval& t) {
        value += t.value;
        return *this;
}

inline Interval& Interval::operator -= ( const Interval& t) {
        value -= t.value;
        return *this;
}

inline Interval& Interval::operator *= ( const int64_t n) {
        value *= n;
        return *this;
}

inline Interval& Interval::operator /= ( const int64_t n) {
        value /= n;
        return *this;
}

// arithmetic functions
inline Interval Interval::operator + ( const Interval &t2 ) const {
        Interval tmp;
        tmp.value = value + t2.value;
        return tmp;
}

inline Interval Interval::operator - ( const Interval &t2 ) const {
        Interval tmp;
        tmp.value = value - t2.value;
        return tmp;
}
inline Interval Interval::operator * ( const int64_t n) const {
        Interval tmp;
        tmp.value = value * n;
        return tmp;
}

inline Interval Interval::operator / ( const int64_t n) const {
        Interval tmp;
        tmp.value = value / n;
        return tmp;
}

// comparison operators
inline bool Interval::operator < (const Interval& x) const {
        return (value < x.value);
}

inline bool Interval::operator > (const Interval& x) const {
        return (value > x.value);
}

inline bool Interval::operator <= (const Interval& x) const {
        return (value <= x.value);
}

inline bool Interval::operator >= (const Interval& x) const {
        return (value >= x.value);
}

inline bool Interval::operator == (const Interval& x) const {
        return (value == x.value);
}
inline bool Interval::equals(const Interval& x) const {
        return (value == x.value);
}

inline bool Interval::operator != (const Interval& x) const {
        return (value != x.value);
}

// unary - and + operators
inline Interval Interval::operator - () const {
        Interval tmp;
        tmp.value = -value;
        return tmp;
}

inline Interval Interval::operator + () const {
        Interval tmp;
    tmp.value = value;
        return tmp;
}

// Conversion functions
inline Interval::operator string () const {
        return toString();
}

inline string Interval::toString() const {
        return toString(value);
}

inline string Interval::toStringI() const {
        return toString(value);
}

inline int64_t Interval::get() const {
        return value;
}

#ifndef WITHOUT_ACS
inline IDLInterval Interval::toIDLInterval() const {
        IDLInterval tmp;
        tmp.value = value;
        return tmp;
}
#endif

// Friend functions

inline Interval operator * ( int64_t n, const Interval &x) {
        Interval tmp;
        tmp.value = x.value * n;
        return tmp;
}

inline ostream & operator << ( ostream &o, const Interval &x ) {
        o << x.value;
        return o;
}

inline istream & operator >> ( istream &i, Interval &x ) {
        i >> x.value;
        return i;
}

inline string Interval::unit() {
        return string ("nanosec");
}

} // End namespace asdm

#endif /* Interval_CLASS */