OpenTREP Logo  0.07.4
C++ Open Travel Request Parsing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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
 
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 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 &)
 
 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 mainly holds:

  • IATA three-letter code
  • Geonames ID
  • Most common used name, in UTF8
  • Most common used name, transliterated in ASCII

Definition at line 28 of file CityDetails.hpp.

Constructor & Destructor Documentation

OPENTREP::CityDetails::CityDetails ( const IATACode_T iIataCode,
const GeonamesID_T iGeonamesID,
const CityUTFName_T iUtfName,
const CityASCIIName_T iAsciiName 
)

Main constructor.

Definition at line 13 of file CityDetails.cpp.

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

Default copy constructor.

Definition at line 29 of file CityDetails.cpp.

OPENTREP::CityDetails::~CityDetails ( )

Destructor.

Definition at line 35 of file CityDetails.cpp.

Member Function Documentation

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

Get the Geonames ID.

Definition at line 41 of file CityDetails.hpp.

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

const CityUTFName_T& OPENTREP::CityDetails::getUtfName ( ) const
inline
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 56 of file CityDetails.hpp.

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

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

Set the IATA code.

Definition at line 66 of file CityDetails.hpp.

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

Set the Geonames ID.

Definition at line 73 of file CityDetails.hpp.

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

Set the name in UTF8.

Definition at line 80 of file CityDetails.hpp.

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 88 of file CityDetails.hpp.

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 64 of file CityDetails.cpp.

References toString().

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 69 of file CityDetails.cpp.

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

Get the serialised version of the structure.

Implements OPENTREP::OPENTREP_Abstract.

Definition at line 57 of file CityDetails.cpp.

References describe().

Referenced by toStream().

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

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

Definition at line 48 of file CityDetails.cpp.

Referenced by toString().

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

Comparison operator.

Definition at line 39 of file CityDetails.cpp.

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

Comparison operator.

Definition at line 147 of file CityDetails.hpp.


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