glass3::parse::GPickParser Class Reference

glass global pick parser class More...

#include <gpickparser.h>

Inheritance diagram for glass3::parse::GPickParser:

Collaboration diagram for glass3::parse::GPickParser:

Public Member Functions
	GPickParser (const std::string &defaultAgencyID, const std::string &defaultAuthor)
	gpickparser constructor More...
	~GPickParser ()
	gpickparser destructor More...
std::shared_ptr< json::Object >	parse (const std::string &input) override
	global pick parsing function More...
Public Member Functions inherited from glass3::parse::Parser
	Parser ()
	Parser (const std::string &defaultAgencyID, const std::string &defaultAuthor)
	parser constructor More...
virtual	~Parser ()
	parser destructor More...
Public Member Functions inherited from glass3::util::BaseClass
	BaseClass ()
	BaseClass constructor. More...
virtual	~BaseClass ()
	BaseClass destructor. More...
virtual bool	setup (std::shared_ptr< const json::Object > config)
	BaseClass configuration function. More...
virtual void	clear ()
	BaseClass clear function. More...
const std::shared_ptr< const json::Object >	getConfig ()
bool	getSetup ()
	Retrieves the class member boolean flag indicating whether the class has been setup, set to true if setup was successful. More...
const std::string &	getDefaultAgencyId ()
	Function to retrieve the name of the default agency id. More...
void	setDefaultAgencyId (const std::string &id)
	Function to set the name of the default agency id. More...
const std::string &	getDefaultAuthor ()
	Function to retrieve the name of the default author. More...
void	setDefaultAuthor (const std::string &author)
	Function to set the name of the default author. More...

Additional Inherited Members
Protected Attributes inherited from glass3::util::BaseClass
std::shared_ptr< const json::Object >	m_Config
	A shared pointer to the json::Object that holds the configuration. More...
std::atomic< bool >	m_bIsSetup
	the boolean flag indicating whether the class has been setup, set to true if setup was successful. More...
std::string	m_DefaultAgencyID
	A std::string containing the default agency id to use in parsing if one is not provided. More...
std::string	m_DefaultAuthor
	A std::string containing the default author to use in parsing if one is not provided. More...

Detailed Description

glass global pick parser class

The glass global pick parser class is a class encapsulating the logic for parsing a global pick message and validating the results.

The global pick message is space delimited and has the following format: 228041013 22637620 1 GLI BHZ AK – 20150302235859.307 P -1.0000 U ? r 1.050 2.650 0.0 0.000000 5.00 0.000000 0.000000 // NOLINT

Where: index 0 is the author/logo index 1 is the pick id index 2 is the global pick message version index 3 is the station code index 4 is the channel code index 5 is the network code index 6 is the location code index 7 is the arrival time index 8 is the phase index 9 is the error window half width index 10 is the polarity index 11 is the onset index 12 is the picker type index 13 is the high pass frequency index 14 is the low pass frequency index 15 is the back azimuth index 16 is the slowness index 17 is the SNR index 18 is the amplitude index 19 is the period

Since the global pick format does not include source agency information, the default agency ID will be used to provide source attribution combined with the author/logo

This class depends on the external earthquake detection formats library to format message strings.

This class uses the external SuperEasyJSON library to return parsed messages

This class inherits from the glass3::parse::Parser class

Constructor & Destructor Documentation

glass3::parse::GPickParser::GPickParser	(	const std::string &	defaultAgencyID,
		const std::string &	defaultAuthor
	)

gpickparser constructor

The constructor for the gpickparser class. Initializes members to provided values.

Parameters

defaultAgencyID	- A std::string containing the agency id to use if one is not provided.
defaultAuthor	- A std::string containing the author to use if one is not provided.

glass3::parse::GPickParser::~GPickParser

(

)

gpickparser destructor

The destructor for the gpickparser class.

Member Function Documentation

std::shared_ptr< json::Object > glass3::parse::GPickParser::parse ( const std::string &  input )

overridevirtual

global pick parsing function

An overridden function (from Parser) used to parse a given global pick string (from a file, broker, or other source) into a SuperEasyJSON object (the common data interchange object) which is returned as a shared_ptr for use in other neic-glass3 functions and classes (such as glasscore).

Parameters

input

- The global pick formatted std::string to parse

Returns

Returns a shared_ptr to the json::Object containing the data.

Implements glass3::parse::Parser.

---

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

• parse/include/gpickparser.h
• parse/src/gpickparser.cpp