Source.h

#ifndef CARMA_SERVICES_SOURCE_H
#define CARMA_SERVICES_SOURCE_H

#include "carma/services/CatalogEntry.h"
#include "carma/services/Angle.h"
#include "carma/services/Distance.h"
#include "carma/services/Velocity.h"

namespace carma {
namespace services {
  class Source : public carma::services::CatalogEntry {
  public:
      Source();

      Source(const std::string& name);

      Source(const std::string& name,
             const Angle& xCoord,
             const Angle& yCoord,
             const Velocity& velocity,
             const Angle& parallax,
             coordSysType coordSys = COORDSYS_RADEC,
             double xProperMotion  = 0.0,
             double yProperMotion  = 0.0,
             const std::string& catalogFormat   = "CARMA",
             unsigned long idNo = 0,
             sourcePntType pntType = PNT_RADIO,
             const std::string& comments = "This Space For Rent"
            );

      Source(const std::string& name,
             const Angle& xCoord,
             const Angle& yCoord,
             const Velocity& velocity,
             const Distance& distance,
             coordSysType coordSys = COORDSYS_RADEC,
             double xProperMotion  = 0.0,
             double yProperMotion  = 0.0,
             const std::string& catalogFormat = "CARMA",
             unsigned long idNo = 0,
             sourcePntType pntType = PNT_RADIO,
             const std::string& comments = "This Space For Rent"
             );


    virtual ~Source();

    void setXCoordinate(const Angle& xcoord);

    void setYCoordinate(const Angle& ycoord);

    void setXProperMotion(double xProperMotion);

    void setYProperMotion(double yProperMotion);

    void setVelocity(const Velocity& velocity);

    void setParallax(const Angle& parallax);

    void setCatalogFormat(const std::string& catalogFormat);

    void setIdNo(unsigned long idNo);

    void setPntType(sourcePntType type) {
        pntType_ = type;
    }

    void setComments(const std::string& comments);

    // inline all the accessor methods

    Angle  getXCoordinate() const {
        return x_;
    }

    Angle  getYCoordinate() const {
        return y_;
    }

    double getXProperMotion() const {
        return xProperMotion_;
    }

    coordSysType getCoordSysType() const {
        return coordSys_;
    }

    double getYProperMotion() const {
        return yProperMotion_;
    }

    Velocity getVelocity() const {
        return velocity_;
    }

    Angle  getParallax() const {
        return parallax_;
    }

    std::string getComments() const {
        return comments_;
    }

    std::string getCatalogFormat() const {
        return catalogFormat_;
    }

    unsigned long getIdNo() const {
        return idNo_;
    }

    sourcePntType getPntType() const {
        return pntType_;
    }

    bool isOptical() const
    {
        return ( pntType_ == PNT_OPTICAL || pntType_ == PNT_BOTH );
    }

    bool isRadio() const {
        return ( pntType_ == PNT_RADIO   || pntType_ == PNT_BOTH );
    }

    bool isPlanet() const
    {
        return Source::isPlanet(getName());
    }

    Distance getDistance() const {
        return Distance::getDistance(parallax_);
    }

    static bool isPlanet(const std::string& sourceName);

  private:
    Angle        x_;             // x coordinate
    Angle        y_;             // y coordinate
    Velocity     velocity_;      // velocity value, frame, definition
    Angle        parallax_;      // trigonometric parallax     
    coordSysType coordSys_;      // coordinate system
    double       xProperMotion_; // milli arcsec (mas) per year
    double       yProperMotion_; // milli arcsec (mas) per year
    std::string  catalogFormat_; // catalog format (for NOVAS)
    unsigned long idNo_;         // source ID number (for NOVAS)
    sourcePntType   pntType_;    // This is a RADIO and/or OPTICAL source.
    std::string  comments_;      // additional comments

    // number of elements in this CatalogEntry
    static const unsigned int NELEMENTS = 11;

  }; // end class Source

std::ostream& operator<<(std::ostream& os, carma::services::Source& source);

} // end services
} // end carma

#endif // CARMA_SERVICES_SOURCE_H