glass3::parse::SimplePickParser Class Reference

glass simple pick parser class More...

#include <simplepickparser.h>

Inheritance diagram for glass3::parse::SimplePickParser:

Collaboration diagram for glass3::parse::SimplePickParser:

Public Member Functions
	SimplePickParser (const std::string &defaultAgencyID, const std::string &defaultAuthor)
	simplepickparser constructor More...
	~SimplePickParser ()
	simplepickparser destructor More...
std::shared_ptr< json::Object >	parse (const std::string &input) override
	simple 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 simple pick parser class

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

The simple pick message has the following format: 57647 AK GLI BHZ – 1568999913.12 P

Where: index 0 is the pick id index 1 is the network code index 2 is the station code index 3 is the channel code index 4 is the location code index 5 is the arrival time index 6 is the phase

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

The phase can be defined as P or S, or left blank for unknown.

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::SimplePickParser::SimplePickParser	(	const std::string &	defaultAgencyID,
		const std::string &	defaultAuthor
	)

simplepickparser constructor

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

glass3::parse::SimplePickParser::~SimplePickParser

(

)

simplepickparser destructor

The destructor for the simplepickparser class.

Member Function Documentation

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

overridevirtual

simple pick parsing function

An overridden function (from Parser) used to parse a given simple 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 simple 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/simplepickparser.h
• parse/src/simplepickparser.cpp