glass3::parse Namespace Reference

The neic-glass3 project namespace containing parsing classes and functions. More...

Classes
class	CCParser
	glass cross correlation message parser class More...
class	GPickParser
	glass global pick parser class More...
class	JSONParser
	json parser class More...
class	Parser
	glass3 parser class More...
class	SimplePickParser
	glass simple pick parser class More...

Functions
std::string	hypoToJSONDetection (std::shared_ptr< json::Object > data, const std::string &outputAgencyID, const std::string &outputAuthor)
	json hypo conversion function More...
std::string	cancelToJSONRetract (std::shared_ptr< json::Object > data, const std::string &outputAgencyID, const std::string &outputAuthor)
	json cancel conversion function More...
std::string	siteListToStationList (std::shared_ptr< json::Object > data)
	json station list conversion function More...
std::string	siteLookupToStationInfoRequest (std::shared_ptr< json::Object > data, const std::string &outputAgencyID, const std::string &outputAuthor)
	json station list conversion function More...

Detailed Description

The neic-glass3 project namespace containing parsing classes and functions.

The neic-glass3 parse namespace contains various classes, and functions used by other components of neic-glass3 to parse data.

Function Documentation

std::string glass3::parse::cancelToJSONRetract	(	std::shared_ptr< json::Object >	data,
		const std::string &	outputAgencyID,
		const std::string &	outputAuthor
	)

json cancel conversion function

The function is used to convert a glasscore Cancel message to a valid detection formats Retract message.

The glasscore Cancel message is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/Cancel.md // NOLINT

The detection formats Retract message is defined at: https://github.com/usgs/earthquake-detection-formats/blob/master/format-docs/Retract.md // NOLINT

outputAgencyID and outputAuthor are required since Retract requires it and Cancel does not provide it

Parameters

data	- A shared_ptr to a json::Object containing the Cancel message to be converted.
outputAgencyID	- A std::string containing the agency id to use for output
outputAuthor	- A std::string containing the author to use for output

Returns

Returns a string containing the converted and validated detection formats Cancel message, empty string otherwise

std::string glass3::parse::hypoToJSONDetection	(	std::shared_ptr< json::Object >	data,
		const std::string &	outputAgencyID,
		const std::string &	outputAuthor
	)

json hypo conversion function

The function is used to convert a glasscore Hypo message to a valid detection formats Detection message

The glasscore cancel message is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/Hypo.md // NOLINT

The detection formats Detection message is defined at: https://github.com/usgs/earthquake-detection-formats/blob/master/format-docs/Detection.md // NOLINT

outputAgencyID and outputAuthor are required since Detection requires it and Hypo does not provide it

Parameters

data	- A shared_ptr to a json::Object containing the Hypo message to be converted.
outputAgencyID	- A std::string containing the agency id to use for output
outputAuthor	- A std::string containing the author to use for output

Returns

Returns a string containing the converted and validated detection formats Detection message, empty string otherwise

The glasscore cancel message is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/Hypo.md // NOLINT

The glasscore station info list is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/StationInfoList.md // NOLINT

The glasscore cancel message is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/Hypo.md // NOLINT

The glasscore station info list is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/StationInfoList.md // NOLINT

std::string glass3::parse::siteListToStationList

(

std::shared_ptr< json::Object >

data

)

json station list conversion function

The function is used to convert a glasscore SiteList message to a StationInfoList messages

The glasscore SiteList message is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/SiteList.md // NOLINT

The glasscore station info list is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/StationInfoList.md // NOLINT/ NOLINT

Parameters

data	- A pointer to a json::Object containing the SiteList to be converted.

Returns

Returns a string containing an array of converted and validated detection formats StationInfo objects, as a StationInfoList message, empty string otherwise

std::string glass3::parse::siteLookupToStationInfoRequest	(	std::shared_ptr< json::Object >	data,
		const std::string &	outputAgencyID,
		const std::string &	outputAuthor
	)

json station list conversion function

The function is used to convert a glasscore SiteLookup message to a valid detection formats StationInfoRequest message.

The glasscore SiteLookup message is defined at: https://github.com/usg/neic-glass3/blob/code-review/doc/internal-formats/SiteLookup.md // NOLINT

The detection formats StationInfoRequest message is defined at: https://github.com/usgs/earthquake-detection-formats/blob/master/format-docs/StationInfoRequest.md // NOLINT

outputAgencyID and outputAuthor are required since StationInfoRequest requires it and SiteLookup does not provide it

Parameters

data	- A shared_ptr to a json::Object containing the SiteLookup message to be converted.
outputAgencyID	- A std::string containing the agency id to use for output
outputAuthor	- A std::string containing the author to use for output

Returns

Returns a string containing the converted and validated detection formats StationInfoRequest message, empty string otherwise