Location.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_LOCATION_HPP
#define __OPENTREP_LOCATION_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// OpenTrep
#include <opentrep/OPENTREP_Types.hpp>
#include <opentrep/OPENTREP_ParserHelperTypes.hpp>
#include <opentrep/OPENTREP_Abstract.hpp>
#include <opentrep/Language.hpp>
#include <opentrep/LocationKey.hpp>
#include <opentrep/NameMatrix.hpp>
#include <opentrep/LocationList.hpp>

namespace OPENTREP {

  struct Location : public OPENTREP_Abstract {
  public:
    // ///////// Getters ////////
    const LocationKey& getKey() const {
      return _key;
    }
    
    const IATACode_T& getIataCode() const {
      return _key.getIataCode();
    }
    
    const IATAType& getIataType() const {
      return _key.getIataType();
    }

    const GeonamesID_T& getGeonamesID() const {
      return _key.getGeonamesID();
    }

    const IsGeonames_T& isGeonames() const {
      return _key.isGeonames();
    }

    const ICAOCode_T& getIcaoCode() const {
      return _icaoCode;
    }
    
    const FAACode_T& getFaaCode() const {
      return _faaCode;
    }
    
    const CommonName_T& getCommonName() const {
      return _commonName;
    }
    
    const ASCIIName_T& getAsciiName() const {
      return _asciiName;
    }
    
    const AltNameShortListString_T& getAltNameShortListString() const {
      return _altNameShortListString;
    }

    const TvlPORListString_T& getTvlPORListString() const {
      return _tvlPORListString;
    }

    const EnvelopeID_T& getEnvelopeID() const {
      return _envelopeID;
    }

    const Date_T& getDateFrom() const {
      return _dateFrom;
    }

    const Date_T& getDateEnd() const {
      return _dateEnd;
    }

    const Comment_T& getComment() const {
      return _comment;
    }

    const CityCode_T& getCityCode() const {
      return _cityCode;
    }
    
    const CityUTFName_T& getCityUtfName() const {
      return _cityUtfName;
    }
    
    const CityASCIIName_T& getCityAsciiName() const {
      return _cityAsciiName;
    }
    
    const GeonamesID_T& getCityGeonamesID() const {
      return _cityGeonamesID;
    }

    const StateCode_T& getStateCode() const {
      return _stateCode;
    }
    
    const CountryCode_T& getCountryCode() const {
      return _countryCode;
    }
    
    const AltCountryCode_T& getAltCountryCode() const {
      return _altCountryCode;
    }
    
    const CountryName_T& getCountryName() const {
      return _countryName;
    }
    
    const ContinentCode_T& getContinentCode() const {
      return _continentCode;
    }
    
    const ContinentName_T& getContinentName() const {
      return _continentName;
    }
    
    const TimeZone_T& getTimeZone() const {
      return _timeZone;
    }
    
    const GMTOffset_T& getGMTOffset() const {
      return _gmtOffset;
    }

    const DSTOffset_T& getDSTOffset() const {
      return _dstOffset;
    }

    const RawOffset_T& getRawOffset() const {
      return _rawOffset;
    }

    const Latitude_T& getLatitude() const {
      return _latitude;
    }

    const Longitude_T& getLongitude() const {
      return _longitude;
    }
    
    const FeatureClass_T& getFeatureClass() const {
      return _featClass;
    }

    const FeatureCode_T& getFeatureCode() const {
      return _featCode;
    }

    const Admin1Code_T& getAdmin1Code() const {
      return _admin1Code;
    }

    const Admin1UTFName_T& getAdmin1UtfName() const {
      return _admin1UtfName;
    }

    const Admin1ASCIIName_T& getAdmin1AsciiName() const {
      return _admin1AsciiName;
    }

    const Admin2Code_T& getAdmin2Code() const {
      return _admin2Code;
    }

    const Admin2UTFName_T& getAdmin2UtfName() const {
      return _admin2UtfName;
    }

    const Admin2ASCIIName_T& getAdmin2AsciiName() const {
      return _admin2AsciiName;
    }

    const Admin3Code_T& getAdmin3Code() const {
      return _admin3Code;
    }

    const Admin4Code_T& getAdmin4Code() const {
      return _admin4Code;
    }

    const Population_T& getPopulation() const {
      return _population;
    }

    const Elevation_T& getElevation() const {
      return _elevation;
    }

    const GTopo30_T& getGTopo30() const {
      return _gTopo30;
    }

    const PageRank_T& getPageRank() const {
      return _pageRank;
    }
    
    const Date_T& getModificationDate() const {
      return _modificationDate;
    }
    
    const WikiLink_T& getWikiLink() const {
      return _wikiLink;
    }

    const NameMatrix& getNameMatrix() const {
      return _nameMatrix;
    }

    bool getNameList (const LanguageCode_T& iLanguageCode,
                      NameList_T& ioNameList) const {
      return _nameMatrix.getNameList (iLanguageCode, ioNameList);
    }

    const std::string& getOriginalKeywords() const {
      return _originalKeywords;
    }
    
    const std::string& getCorrectedKeywords() const {
      return _correctedKeywords;
    }
    
    const MatchingPercentage_T& getPercentage() const {
      return _percentage;
    }

    const NbOfErrors_T& getEditDistance() const {
      return _editDistance;
    }

    const NbOfErrors_T& getAllowableEditDistance () const {
      return _allowableEditDistance;
    }
    
    const LocationList_T& getExtraLocationList() const {
      return _extraLocationList;
    }

    const LocationList_T& getAlternateLocationList() const {
      return _alternateLocationList;
    }

    const RawDataString_T& getRawDataString() const {
      return _rawDataString;
    }


  public:
    // ///////////////////// Setters //////////////////////
    void setKey (const LocationKey& iKey) {
      _key = iKey;
    }
    
    void setIataCode (const std::string& iIataCode) {
      _key.setIataCode (iIataCode);
    }
    
    void setIataType (const IATAType& iIATAType) {
      _key.setIataType (iIATAType);
    }

    void setGeonamesID (const GeonamesID_T& iGeonamesID) {
      _key.setGeonamesID (iGeonamesID);
    }

    void setIcaoCode (const std::string& iIcaoCode) {
      _icaoCode = ICAOCode_T (iIcaoCode);
    }
    
    void setFaaCode (const std::string& iFaaCode) {
      _faaCode = FAACode_T (iFaaCode);
    }
    
    void setCommonName (const std::string& iName) {
      _commonName = CommonName_T (iName);
    }
    
    void setAsciiName (const std::string& iName) {
      _asciiName = ASCIIName_T (iName);
    }
    
    void setAltNameShortListString (const std::string& iNameListString) {
      _altNameShortListString = AltNameShortListString_T (iNameListString);
    }

    void setTvlPORListString (const std::string& iPORListString) {
      _tvlPORListString = TvlPORListString_T (iPORListString);
    }

    void setEnvelopeID (const EnvelopeID_T& iEnvelopeID) {
      _envelopeID = iEnvelopeID;
    }

    void setDateFrom (const Date_T& iDate) {
      _dateFrom = iDate;
    }

    void setDateEnd (const Date_T& iDate) {
      _dateEnd = iDate;
    }

    void setComment (const std::string& iComment) {
      _comment = Comment_T (iComment);
    }

    void setCityCode (const std::string& iCityCode) {
      _cityCode = CityCode_T (iCityCode);
    }
    
    void setCityUtfName (const std::string& iCityUtfName) {
      _cityUtfName = CityUTFName_T (iCityUtfName);
    }
    
    void setCityAsciiName (const std::string& iCityAsciiName) {
      _cityAsciiName = CityASCIIName_T (iCityAsciiName);
    }
    
    void setCityGeonamesID (const GeonamesID_T& iGeonamesID) {
      _cityGeonamesID = iGeonamesID;
    }

    void setCountryCode (const std::string& iCountryCode) {
      _countryCode = CountryCode_T (iCountryCode);
    }
    
    void setAltCountryCode (const std::string& iCountryCode) {
      _altCountryCode = AltCountryCode_T (iCountryCode);
    }
    
    void setCountryName (const std::string& iCountryName) {
      _countryName = CountryName_T (iCountryName);
    }
    
    void setStateCode (const std::string& iStateCode) {
      _stateCode = StateCode_T (iStateCode);
    }
    
    void setContinentCode (const std::string& iContinentCode) {
      _continentCode = ContinentCode_T (iContinentCode);
    }
    
    void setContinentName (const std::string& iContinentName) {
      _continentName = ContinentName_T (iContinentName);
    }
    
    void setTimeZone (const std::string& iTimeZone) {
      _timeZone = TimeZone_T (iTimeZone);
    }
    
    void setGMTOffset (const GMTOffset_T& iOffset) {
      _gmtOffset = iOffset;
    }

    void setDSTOffset (const DSTOffset_T& iOffset) {
      _dstOffset = iOffset;
    }

    void setRawOffset (const RawOffset_T& iOffset) {
      _rawOffset = iOffset;
    }

    void setLatitude (const Latitude_T& iLatitude) {
      _latitude = iLatitude;
    }

    void setLongitude (const Longitude_T& iLongitude) {
      _longitude = iLongitude;
    }
    
    void setFeatureClass (const std::string& iFeatClass) {
      _featClass = FeatureClass_T (iFeatClass);
    }

    void setFeatureCode (const std::string& iFeatCode) {
      _featCode = FeatureCode_T (iFeatCode);
    }

    void setAdmin1Code (const std::string& iAdminCode) {
      _admin1Code = Admin1Code_T (iAdminCode);
    }

    void setAdmin1UtfName (const std::string& iAdminName) {
      _admin1UtfName = Admin1UTFName_T (iAdminName);
    }

    void setAdmin1AsciiName (const std::string& iAdminName) {
      _admin1AsciiName = Admin1ASCIIName_T (iAdminName);
    }

    void setAdmin2Code (const std::string& iAdminCode) {
      _admin2Code = Admin2Code_T (iAdminCode);
    }

    void setAdmin2UtfName (const std::string& iAdminName) {
      _admin2UtfName = Admin2UTFName_T (iAdminName);
    }

    void setAdmin2AsciiName (const std::string& iAdminName) {
      _admin2AsciiName = Admin2ASCIIName_T (iAdminName);
    }

    void setAdmin3Code (const std::string& iAdminCode) {
      _admin3Code = Admin3Code_T (iAdminCode);
    }

    void setAdmin4Code (const std::string& iAdminCode) {
      _admin4Code = Admin4Code_T (iAdminCode);
    }

    void setPopulation (const Population_T& iPopulation) {
      _population = iPopulation;
    }

    void setElevation (const Elevation_T& iElevation) {
      _elevation = iElevation;
    }

    void setGTopo30 (const GTopo30_T& iGTopo30) {
      _gTopo30 = iGTopo30;
    }

    void setPageRank (const PageRank_T& iPageRank) {
      _pageRank = iPageRank;
    }
    
    void setModificationDate (const Date_T& iModDate) {
      _modificationDate = iModDate;
    }

    void setWikiLink (const std::string& iWikiLink) {
      _wikiLink = WikiLink_T (iWikiLink);
    }
    
    void addName (const LanguageCode_T& iLanguageCode,
                  const std::string& iName) {
      _nameMatrix.addName (iLanguageCode, iName);
    }

    void resetMatrix() {
      _nameMatrix.reset();
    }

    void setOriginalKeywords (const std::string& iOriginalKeywords) {
      _originalKeywords = iOriginalKeywords;
    }
    
    void setCorrectedKeywords (const std::string& iCorrectedKeywords) {
      _correctedKeywords = iCorrectedKeywords;
    }
    
    void setPercentage (const MatchingPercentage_T& iPercentage) {
      _percentage = iPercentage;
    }

    void setEditDistance (const NbOfErrors_T& iEditDistance) {
      _editDistance = iEditDistance;
    }

    void setAllowableEditDistance (const NbOfErrors_T& iAllowableEditDistance) {
      _allowableEditDistance = iAllowableEditDistance;
    }
    
    void addExtraLocation (const Location& iExtraLocation) {
      _extraLocationList.push_back (iExtraLocation);
    }
    
    void addAlternateLocation (const Location& iAlternateLocation) {
      _alternateLocationList.push_back (iAlternateLocation);
    }
    
    void setRawDataString (const std::string& iRawDataString) {
      _rawDataString = RawDataString_T (iRawDataString);
    }


  public:
    // ///////// Parsing support methods ////////
    Date_T calculateDate() const;

    void consolidateAltNameShortListString();

    void consolidateTvlPORListString();

    static FeatureNameList_T getFeatureList (const FeatureCode_T&);


  public:
    // ///////// Display methods ////////
    void toStream (std::ostream&) const;

    void fromStream (std::istream&);

    std::string toString() const;

    std::string describeKey() const;

    std::string describeShortKey() const;
    
    std::string toBasicString() const;

    std::string toShortString() const;

    std::string toSingleLocationString() const;

    
  public:
    Location (const IATACode_T&, const IATAType&, const GeonamesID_T&,
              const ICAOCode_T&, const FAACode_T&,
              const CommonName_T&, const ASCIIName_T&,
              const EnvelopeID_T&,
              const Date_T& iDateFrom, const Date_T& iDateEnd, const Comment_T&,
              const CityCode_T&, const CityUTFName_T&, const CityASCIIName_T&,
              const GeonamesID_T&,
              const StateCode_T&, const CountryCode_T&, const AltCountryCode_T&,
              const CountryName_T&, const ContinentName_T&,
              const Latitude_T&, const Longitude_T&,
              const FeatureClass_T&, const FeatureCode_T&,
              const Admin1Code_T&, const Admin1UTFName_T&,
              const Admin1ASCIIName_T&,
              const Admin2Code_T&, const Admin2UTFName_T&,
              const Admin2ASCIIName_T&,
              const Admin3Code_T&, const Admin4Code_T&,
              const Population_T&, const Elevation_T&, const GTopo30_T&,
              const TimeZone_T&,
              const GMTOffset_T&, const DSTOffset_T&, const RawOffset_T&,
              const Date_T& iModDate, const TvlPORListString_T&,
              const WikiLink_T&, const PageRank_T&,
              const std::string& iOriginalKeywords,
              const std::string& iCorrectedKeywords,
              const MatchingPercentage_T& iPercentage,
              const NbOfErrors_T& iEditDistance,
              const NbOfErrors_T& iAllowableEditDistance,
              const RawDataString_T&);

    Location();

    Location (const Location&);
    
    ~Location();

    
  private:
    // /////// Attributes /////////
    LocationKey _key;

    ICAOCode_T _icaoCode;

    FAACode_T _faaCode;

    CommonName_T _commonName;
    
    ASCIIName_T _asciiName;
    
    AltNameShortListString_T _altNameShortListString;

    TvlPORListString_T _tvlPORListString;

    EnvelopeID_T _envelopeID;

    Date_T _dateFrom;

    Date_T _dateEnd;

    Comment_T _comment;

    CityCode_T _cityCode;

    CityUTFName_T _cityUtfName;

    CityASCIIName_T _cityAsciiName;

    GeonamesID_T _cityGeonamesID;

    StateCode_T _stateCode;

    CountryCode_T _countryCode;

    AltCountryCode_T _altCountryCode;

    CountryName_T _countryName;

    ContinentCode_T _continentCode;

    ContinentName_T _continentName;

    Latitude_T _latitude;

    Longitude_T _longitude;

    FeatureClass_T _featClass;

    FeatureCode_T _featCode;

    Admin1Code_T _admin1Code;

    Admin1UTFName_T _admin1UtfName;

    Admin1ASCIIName_T _admin1AsciiName;

    Admin2Code_T _admin2Code;

    Admin2UTFName_T _admin2UtfName;

    Admin2ASCIIName_T _admin2AsciiName;

    Admin3Code_T _admin3Code;

    Admin4Code_T _admin4Code;

    Population_T _population;

    Elevation_T _elevation;

    GTopo30_T _gTopo30;

    TimeZone_T _timeZone;

    GMTOffset_T _gmtOffset;

    DSTOffset_T _dstOffset;

    RawOffset_T _rawOffset;

    Date_T _modificationDate;

    WikiLink_T _wikiLink;

    PageRank_T _pageRank;

    NameMatrix _nameMatrix;

  private:
    // ///////////// Full-text matching process support attributes //////////
    std::string _originalKeywords;
    
    std::string _correctedKeywords;
    
    MatchingPercentage_T _percentage;

    NbOfErrors_T _editDistance;

    NbOfErrors_T _allowableEditDistance;
    
    LocationList_T _extraLocationList;

    LocationList_T _alternateLocationList;

    RawDataString_T _rawDataString;


  public:
    // ///////// Parsing support temporary attributes ////////
    year_t _itYear;
    month_t _itMonth;
    day_t _itDay;

    Language::EN_Language _itLanguageCodeNum;
    LanguageCode_T _itLanguageCode;
    std::string _itLangCode2Char;
    std::string _itLangCodeExt;
    std::string _itLangCodeHist;
    AltNameShortList_T _itAltNameShortList;
    TvlPORList_T _itTvlPORList;
  };

}
#endif // __OPENTREP_LOCATION_HPP