Bridges-C++  3.4.4
Bridges(C++ API)
Public Member Functions | List of all members
bridges::dataset::EarthquakeUSGS Class Reference

#include <EarthquakeUSGS.h>

Detailed Description

Class that hold earthquake data, for use with USGIS retrieved quake data.

Class that holds earthquake USGIS data. BRIDGES uses scripts to continually monitor USGIS site (tweets) and retrieve the latest quake data for use in student projects.

One would normally not create an object of that type but rather obtain one by calling bridges::DataSource::getEarthquakeUSGSData()

See also
Refer to the tutorial on how to use this dataset: https://bridgesuncc.github.io/tutorials/Data_EQ_USGS.html
Author
Kalpathi Subramanian, 2/18/18

Public Member Functions

 EarthquakeUSGS ()
 
 EarthquakeUSGS (double magnitude, double longit, double latit, const string &location, const string &title, const string &url, const string &time)
 
 EarthquakeUSGS (const EarthquakeUSGS *eq)
 
string getTime () const
 return the epoch time of the quake More...
 
string getDateStr () const
 returns the real date in a string format More...
 
void setTime (const string &tm)
 set epoch time More...
 
int getYear () const
 get year of quake More...
 
int getMonth () const
 get month of quake More...
 
int getDay () const
 get day of quake More...
 
int getHour () const
 get hour of quake More...
 
int getMinutes () const
 get minutes of quake More...
 
int getSeconds () const
 get seconds of quake More...
 
float getLatit () const
 get latitude of quake More...
 
void setLatit (float latit)
 set latitude More...
 
float getLongit () const
 get longitude of quake location More...
 
void setLongit (float longit)
 set longitude of quake location More...
 
string getLocation () const
 get quake location. More...
 
void setLocation (string location)
 set quake location (string) More...
 
string getTitle () const
 get quake title More...
 
void setTitle (const string &title)
 set quake title More...
 
string getUrl () const
 get quake url More...
 
void setUrl (const string &url)
 set quake url More...
 
double getMagnitude () const
 get quake magnitude More...
 
void setMagnitude (double magnitude)
 set quake magnitude More...
 

Constructor & Destructor Documentation

◆ EarthquakeUSGS() [1/3]

bridges::dataset::EarthquakeUSGS::EarthquakeUSGS ( )
inline

Default Constructor

◆ EarthquakeUSGS() [2/3]

bridges::dataset::EarthquakeUSGS::EarthquakeUSGS ( double  magnitude,
double  longit,
double  latit,
const string &  location,
const string &  title,
const string &  url,
const string &  time 
)
inline

Constructor

Parameters
magnitudequake magnitude
longitlongitude of quake
latitlatitude of quake
locationlocation of quake
titletitle of quake (has some attributes of quake)
urlurl of quake
timeoccurrence time

◆ EarthquakeUSGS() [3/3]

bridges::dataset::EarthquakeUSGS::EarthquakeUSGS ( const EarthquakeUSGS eq)
inline

Member Function Documentation

◆ getDateStr()

string bridges::dataset::EarthquakeUSGS::getDateStr ( ) const
inline

returns the real date in a string format

Returns
the real date in format "Month Day Year Hour:Minute:Seconds"

◆ getDay()

int bridges::dataset::EarthquakeUSGS::getDay ( ) const
inline

get day of quake

Returns
day of the quake

◆ getHour()

int bridges::dataset::EarthquakeUSGS::getHour ( ) const
inline

get hour of quake

Returns
hour of the quake

◆ getLatit()

float bridges::dataset::EarthquakeUSGS::getLatit ( ) const
inline

get latitude of quake

Returns
latitude of the quake

◆ getLocation()

string bridges::dataset::EarthquakeUSGS::getLocation ( ) const
inline

get quake location.

This is astring describing location (typically a city or something of the sort)

Returns
location as a string

◆ getLongit()

float bridges::dataset::EarthquakeUSGS::getLongit ( ) const
inline

get longitude of quake location

Returns
longitude of the quake

◆ getMagnitude()

double bridges::dataset::EarthquakeUSGS::getMagnitude ( ) const
inline

get quake magnitude

Returns
magnitude of the scale on Richter scale

◆ getMinutes()

int bridges::dataset::EarthquakeUSGS::getMinutes ( ) const
inline

get minutes of quake

Returns
minutes of the quake

◆ getMonth()

int bridges::dataset::EarthquakeUSGS::getMonth ( ) const
inline

get month of quake

Returns
month of the quake

◆ getSeconds()

int bridges::dataset::EarthquakeUSGS::getSeconds ( ) const
inline

get seconds of quake

Returns
get seconds of the quake

◆ getTime()

string bridges::dataset::EarthquakeUSGS::getTime ( ) const
inline

return the epoch time of the quake

Returns
time

◆ getTitle()

string bridges::dataset::EarthquakeUSGS::getTitle ( ) const
inline

get quake title

Typically a one line description of the quake

Returns
title

◆ getUrl()

string bridges::dataset::EarthquakeUSGS::getUrl ( ) const
inline

get quake url

Returns
USGIS url about the quake

◆ getYear()

int bridges::dataset::EarthquakeUSGS::getYear ( ) const
inline

get year of quake

Returns
year of the quake

◆ setLatit()

void bridges::dataset::EarthquakeUSGS::setLatit ( float  latit)
inline

set latitude

Parameters
[in]latitlatitude

◆ setLocation()

void bridges::dataset::EarthquakeUSGS::setLocation ( string  location)
inline

set quake location (string)

Parameters
[in]locationlocation

◆ setLongit()

void bridges::dataset::EarthquakeUSGS::setLongit ( float  longit)
inline

set longitude of quake location

Parameters
[in]longitlongitude of the quake

◆ setMagnitude()

void bridges::dataset::EarthquakeUSGS::setMagnitude ( double  magnitude)
inline

set quake magnitude

Parameters
[in]magnitudemagnitude of the quake on Richter scale

◆ setTime()

void bridges::dataset::EarthquakeUSGS::setTime ( const string &  tm)
inline

set epoch time

Parameters
tmtime as epoch

◆ setTitle()

void bridges::dataset::EarthquakeUSGS::setTitle ( const string &  title)
inline

set quake title

Parameters
[in]titlequake title

◆ setUrl()

void bridges::dataset::EarthquakeUSGS::setUrl ( const string &  url)
inline

set quake url

Parameters
[in]urlUSGIS url of the quake

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