Bridges-C++  3.4.2
Bridges(C++ API)
Public Member Functions | List of all members
Amenity Class Reference

#include <Amenity.h>

Detailed Description

Class that hold Open Street Map Amenity data.

This class holds the individual information for each amenity requested

Usually this class is not created by the user but part of an AmenityData object returned by bridges::DataSource::getAmenityData()

See also
Check out the tutorial on getting amenity data at https://bridgesuncc.github.io/tutorials/Data_Amenity.html
Author
Kalpathi Subramanian
Date
1/28/21

Public Member Functions

 Amenity ()
 
 Amenity (double id_val, double lat, double lon, string name, vector< string > other)
 
long getId ()
 
void setId (long id)
 
double getLat ()
 
void setLat (double latitude)
 
double getLon ()
 
void setLon (double longitude)
 
string getName ()
 
void setName (string n)
 
vector< string > getOther ()
 
void setOther (vector< string > oth)
 

Constructor & Destructor Documentation

◆ Amenity() [1/2]

Amenity::Amenity ( )
inline

Default Constructor

◆ Amenity() [2/2]

Amenity::Amenity ( double  id_val,
double  lat,
double  lon,
string  name,
vector< string >  other 
)
inline

Constructor

Parameters
id_valAmenity ID as stored in Open Street Maps
latLatitude of Amenity
lonLongitude of Amenity
nameName of Amenity as found in Open Street Maps
otherList of special values that may have come with the amenity

Member Function Documentation

◆ getId()

long Amenity::getId ( )
inline

get the ID of this amenity

Returns
ID value

◆ getLat()

double Amenity::getLat ( )
inline

get the latitude of this amenity data

Returns
amenity data latitude

◆ getLon()

double Amenity::getLon ( )
inline

get the longitude of this amenity data

Returns
amenity data longitude

◆ getName()

string Amenity::getName ( )
inline

get the name of this amenity data

Returns
name of this amenity

◆ getOther()

vector<string> Amenity::getOther ( )
inline

get the extra data present for certain amenities

Returns
list of extra data

◆ setId()

void Amenity::setId ( long  id)
inline

set the ID value of this amenity

Parameters
id_valID value to set

◆ setLat()

void Amenity::setLat ( double  latitude)
inline

set the latitude value of this amenity

Parameters
latlatitude position to set

◆ setLon()

void Amenity::setLon ( double  longitude)
inline

set the longitude value of this amenity

Parameters
lonlongitude position to set

◆ setName()

void Amenity::setName ( string  n)
inline

set the name of this amenity

Parameters
namename of amenity to set

◆ setOther()

void Amenity::setOther ( vector< string >  oth)
inline

set the extra data present for certain amenities

Parameters
other

The documentation for this class was generated from the following file: