mspass::utility::BasicProcessingHistory Class Reference

#include <ProcessingHistory.h>

Inheritance diagram for mspass::utility::BasicProcessingHistory:

Public Member Functions
	BasicProcessingHistory (const std::string jobname, const std::string jobid)
	BasicProcessingHistory (const BasicProcessingHistory &parent)
virtual size_t	number_of_stages ()
std::string	jobid () const
void	set_jobid (const std::string &newjid)
std::string	jobname () const
void	set_jobname (const std::string jobname)
BasicProcessingHistory &	operator= (const BasicProcessingHistory &parent)

Protected Attributes
std::string	jid
std::string	jnm

Detailed Description

Base class defining core concepts.

Constructor & Destructor Documentation

BasicProcessingHistory() [1/3]

mspass::utility::BasicProcessingHistory::BasicProcessingHistory ( )

inline

                           {
    jid = std::string();
    jnm = std::string();
  };

~BasicProcessingHistory()

virtual mspass::utility::BasicProcessingHistory::~BasicProcessingHistory ( )

inlinevirtual

{};

BasicProcessingHistory() [2/3]

mspass::utility::BasicProcessingHistory::BasicProcessingHistory ( const std::string  jobname, const std::string  jobid  )

inline

                                                                         {
    jid = jobid;
    jnm = jobname;
  };

BasicProcessingHistory() [3/3]

mspass::utility::BasicProcessingHistory::BasicProcessingHistory ( const BasicProcessingHistory &  parent )

inline

                                                               {
    jid = parent.jid;
    jnm = parent.jnm;
  };

Member Function Documentation

jobid()

std::string mspass::utility::BasicProcessingHistory::jobid ( ) const

inline

{ return jid; };

jobname()

std::string mspass::utility::BasicProcessingHistory::jobname ( ) const

inline

{ return jnm; };

number_of_stages()

virtual size_t mspass::utility::BasicProcessingHistory::number_of_stages ( )

inlinevirtual

Return number or processing algorithms applied to produce these data.

Implementations of this method need to return a count of the number of processing steps that have been applied to put the data in the current state. This method could be made pure, but for convenience the base class always returns 0 since it does not implement the actual history mechanism.

Reimplemented in mspass::utility::ProcessingHistory.

{ return 0; };

operator=()

BasicProcessingHistory & mspass::utility::BasicProcessingHistory::operator= ( const BasicProcessingHistory &  parent )

inline

                                                                          {
    if (this != (&parent)) {
      jnm = parent.jnm;
      jid = parent.jid;
    }
    return *this;
  }

set_jobid()

void mspass::utility::BasicProcessingHistory::set_jobid ( const std::string &  newjid )

inline

{ jid = newjid; };

set_jobname()

void mspass::utility::BasicProcessingHistory::set_jobname ( const std::string  jobname )

inline

{ jnm = jobname; };

---

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

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