OpenTREP Logo  0.07.18
C++ Open Travel Request Parsing Library
Loading...
Searching...
No Matches
OPENTREP::CityDetails Struct Reference

Class modelling the elementary details of a city. More...

#include <opentrep/CityDetails.hpp>

+ Inheritance diagram for OPENTREP::CityDetails:

Public Member Functions

const IATACode_TgetIataCode () const
 
const GeonamesID_TgetGeonamesID () const
 
const CityUTFName_TgetUtfName () const
 
const CityASCIIName_TgetAsciiName () const
 
const CountryCode_TgetCountryCode () const
 
const StateCode_TgetStateCode () const
 
void setIataCode (const std::string &iIataCode)
 
void setGeonamesID (const GeonamesID_T &iGeonamesID)
 
void setUtfName (const CityUTFName_T &iUtfName)
 
void setAsciiName (const CityASCIIName_T &iAsciiName)
 
void setCountryCode (const std::string &iCountryCode)
 
void setStateCode (const std::string &iStateCode)
 
void toStream (std::ostream &) const
 
void fromStream (std::istream &)
 
std::string toString () const
 
std::string describe () const
 
 CityDetails (const IATACode_T &, const GeonamesID_T &, const CityUTFName_T &, const CityASCIIName_T &, const CountryCode_T &, const StateCode_T &)
 
 CityDetails (const CityDetails &)
 
 ~CityDetails ()
 
bool operator== (const CityDetails &) const
 
bool operator!= (const CityDetails &iCityDetails) const
 

Detailed Description

Class modelling the elementary details of a city.

The CityDetails structure contains:

  • IATA three-letter code
  • Geonames ID
  • Most common used name, in UTF8
  • Most common used name, transliterated in ASCII
  • Country code (of the city)
  • State (ISO-3166-2) code (of the city)

Definition at line 30 of file CityDetails.hpp.

Constructor & Destructor Documentation

◆ CityDetails() [1/2]

OPENTREP::CityDetails::CityDetails ( const IATACode_T & iIataCode,
const GeonamesID_T & iGeonamesID,
const CityUTFName_T & iUtfName,
const CityASCIIName_T & iAsciiName,
const CountryCode_T & iCountryCode,
const StateCode_T & iStateCode )

Main constructor.

Definition at line 13 of file CityDetails.cpp.

References CityDetails().

Referenced by CityDetails(), CityDetails(), operator!=(), and operator==().

◆ CityDetails() [2/2]

OPENTREP::CityDetails::CityDetails ( const CityDetails & iCityDetails)

Default copy constructor.

Definition at line 32 of file CityDetails.cpp.

References CityDetails().

◆ ~CityDetails()

OPENTREP::CityDetails::~CityDetails ( )

Destructor.

Definition at line 40 of file CityDetails.cpp.

Member Function Documentation

◆ getIataCode()

const IATACode_T & OPENTREP::CityDetails::getIataCode ( ) const
inline

◆ getGeonamesID()

const GeonamesID_T & OPENTREP::CityDetails::getGeonamesID ( ) const
inline

Get the Geonames ID.

Definition at line 43 of file CityDetails.hpp.

Referenced by OPENTREP::LocationExchange::exportLocation(), and OPENTREP::BomJSONExport::jsonExportLocation().

◆ getUtfName()

const CityUTFName_T & OPENTREP::CityDetails::getUtfName ( ) const
inline

◆ getAsciiName()

const CityASCIIName_T & OPENTREP::CityDetails::getAsciiName ( ) const
inline

Get the name in ASCII (not necessarily in English). That corresponds to the transliterated version of the Unicode one.

Definition at line 58 of file CityDetails.hpp.

Referenced by OPENTREP::Place::buildIndexSets(), OPENTREP::LocationExchange::exportLocation(), and OPENTREP::BomJSONExport::jsonExportLocation().

◆ getCountryCode()

const CountryCode_T & OPENTREP::CityDetails::getCountryCode ( ) const
inline

Get the country code (of the city).

Definition at line 65 of file CityDetails.hpp.

◆ getStateCode()

const StateCode_T & OPENTREP::CityDetails::getStateCode ( ) const
inline

Get the state (ISO-3166-2) code (of the city).

Definition at line 72 of file CityDetails.hpp.

◆ setIataCode()

void OPENTREP::CityDetails::setIataCode ( const std::string & iIataCode)
inline

Set the IATA code.

Definition at line 82 of file CityDetails.hpp.

◆ setGeonamesID()

void OPENTREP::CityDetails::setGeonamesID ( const GeonamesID_T & iGeonamesID)
inline

Set the Geonames ID.

Definition at line 89 of file CityDetails.hpp.

◆ setUtfName()

void OPENTREP::CityDetails::setUtfName ( const CityUTFName_T & iUtfName)
inline

Set the name in UTF8.

Definition at line 96 of file CityDetails.hpp.

◆ setAsciiName()

void OPENTREP::CityDetails::setAsciiName ( const CityASCIIName_T & iAsciiName)
inline

Set the name in ASCII (not necessarily in English). That corresponds to the transliterated version of the Unicode one.

Definition at line 104 of file CityDetails.hpp.

◆ setCountryCode()

void OPENTREP::CityDetails::setCountryCode ( const std::string & iCountryCode)
inline

Set the country code.

Definition at line 111 of file CityDetails.hpp.

◆ setStateCode()

void OPENTREP::CityDetails::setStateCode ( const std::string & iStateCode)
inline

Set the state code.

Definition at line 118 of file CityDetails.hpp.

◆ toStream()

void OPENTREP::CityDetails::toStream ( std::ostream & ioOut) const
virtual

Dump the structure into an output stream.

Parameters
ostream&the output stream.

Implements OPENTREP::OPENTREP_Abstract.

Definition at line 72 of file CityDetails.cpp.

References toString().

◆ fromStream()

void OPENTREP::CityDetails::fromStream ( std::istream & ioIn)
virtual

Read a structure from an input stream.

Parameters
istream&the input stream.

Implements OPENTREP::OPENTREP_Abstract.

Definition at line 77 of file CityDetails.cpp.

◆ toString()

std::string OPENTREP::CityDetails::toString ( ) const
virtual

Get the serialised version of the structure.

Implements OPENTREP::OPENTREP_Abstract.

Definition at line 65 of file CityDetails.cpp.

References describe().

Referenced by toStream().

◆ describe()

std::string OPENTREP::CityDetails::describe ( ) const

Get a string describing the whole key (differentiating two objects at any level).

Definition at line 55 of file CityDetails.cpp.

Referenced by toString().

◆ operator==()

bool OPENTREP::CityDetails::operator== ( const CityDetails & iCityDetails) const

Comparison operator.

Definition at line 44 of file CityDetails.cpp.

References CityDetails().

◆ operator!=()

bool OPENTREP::CityDetails::operator!= ( const CityDetails & iCityDetails) const
inline

Comparison operator.

Definition at line 178 of file CityDetails.hpp.

References CityDetails().


The documentation for this struct was generated from the following files: