mspass::utility::NodeData Class Reference

Holds properties of data used as input to algorithm that created this object. More...

#include <ProcessingHistory.h>

Public Member Functions
	NodeData (const NodeData &parent)
NodeData &	operator= (const NodeData &parent)
bool	operator== (const NodeData &other)
bool	operator!= (const NodeData &other)

Public Attributes
mspass::utility::ProcessingStatus	status
std::string	uuid
mspass::utility::AtomicType	type
int	stage
std::string	algorithm
	Name of algorithm algorithm applied at this stage. More...
std::string	algid

Detailed Description

Holds properties of data used as input to algorithm that created this object.

The implementation here uses a multimap to define parents of each uuid in a history chain. This class is used mainly internally for ProcessingHistory to maintain that data. It will be visible to C++ programs but will not be visible in python. One of these entries is created for each parent data used to create the current data.

Member Data Documentation

algid

std::string mspass::utility::NodeData::algid

id string to identify this instance of algorithm.

Only assumption is that the combination of algorithm and id provide a unique specification of a particular instance of an algorithm. That means some algorithm and a particular set of control parameters that control the outcome of the algorithm. In MsPASS this is usually the ObjectID string of saved parameters in MongoDB, but users can use any method they wish to describe a unique combination of parameters and an algorithm implementation.

algorithm

std::string mspass::utility::NodeData::algorithm

Name of algorithm algorithm applied at this stage.

We use the concept that every processing algorithm has a name keyword that togther with an id and/or instance defines a unique definition of the algorithm and a set of input parameters that define the algorithm's behavior. Note this is the algorithm that creates the uuid also stored in this struct (class)

stage

int mspass::utility::NodeData::stage

Integer count of the number of processing steps applied to create this parent.

status

mspass::utility::ProcessingStatus mspass::utility::NodeData::status

status definition of the parent.

type

mspass::utility::AtomicType mspass::utility::NodeData::type

This enum can be used to track changes in data type.

uuid

std::string mspass::utility::NodeData::uuid

uuid of the parent.

---

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

• /home/runner/work/mspass/mspass/cxx/include/mspass/utility/ProcessingHistory.h
• /home/runner/work/mspass/mspass/cxx/src/lib/utility/ProcessingHistory.cc