mspass::utility::ProcessManager Class Reference

Manager for process-level algorithm and job identifiers. More...

#include <ProcessManager.h>

Public Member Functions
	ProcessManager ()
	ProcessManager (std::string fname)
AlgorithmDefinition	algorithm (const std::string name, const size_t instance=0) const
std::string	jobname () const
std::string	jobid () const
std::string	new_newid ()
	Get a new UUID to define unique job run.

Detailed Description

Manager for process-level algorithm and job identifiers.

Constructor & Destructor Documentation

ProcessManager() [1/2]

mspass::utility::ProcessManager::ProcessManager

(

)

Construct a default process manager.

: jobnm() { job_uuid = gen(); };

ProcessManager() [2/2]

mspass::utility::ProcessManager::ProcessManager

(

std::string

fname

)

Construct from a serialized process-manager file.

                                              {
  const string base_error("ProcessManager file constructor:  ");
  try {
    job_uuid = gen();
    ifstream ifs;
    ifs.open(fname.c_str(), std::ifstream::in);
    if (!ifs.is_open())
      throw MsPASSError(base_error + "fopen failed for file=" + fname,
                        ErrorSeverity::Fatal);
    /* job names needs to be the first line */
    ifs >> jobnm;
    /* Now we loop over lines with algorithm name and and idstring */
    char inp[128];
    while (ifs.getline(inp, 128)) {
      map<string, vector<AlgorithmDefinition>>::iterator aptr;
      stringstream ss(inp);
      string algnm, idin, inptyp, outtyp;
      ss >> algnm;
      ss >> idin;
      ss >> inptyp;
      ss >> outtyp;
      AlgorithmDefinition thisalg(algnm, inptyp, outtyp, idin);
      aptr = algs.find(algnm);
      if (aptr == algs.end()) {
        vector<AlgorithmDefinition> temp;
        temp.push_back(thisalg);
        algs.insert(pair<string, vector<AlgorithmDefinition>>(algnm, temp));
      } else {
        aptr->second.push_back(thisalg);
      }
    }
  } catch (...) {
    throw;
  };
};

Member Function Documentation

algorithm()

AlgorithmDefinition mspass::utility::ProcessManager::algorithm	(	const std::string	name,
		const size_t	instance = 0
	)		const

Return an algorithm definition by name and instance number.

                                                                           {
  size_t i;
  map<string, vector<AlgorithmDefinition>>::const_iterator aptr;
  aptr = algs.find(name);
  if (aptr == algs.end()) {
    /* If the name is not registered the map we don't want this
    method to throw an error.  Instead we return the name with
    the id field set to UNDEFINED*/
    return AlgorithmDefinition(name, "UNDEFINED", "UNDEFINED", "UNDEFINED");
  } else {
    i = instance;
    if (instance >= (aptr->second.size())) {
      cerr << "ProcessManager::algorithm(Warning):  "
           << "algorithm=" << name
           << " was defined but requested instance=" << instance
           << " exceeds number of defined instances=" << aptr->second.size()
           << endl
           << "Set to id for instance=" << aptr->second.size() - 1 << endl
           << "History data may be invalid" << endl;
      i = aptr->second.size() - 1;
    }
  }
  return aptr->second[i];
}

jobid()

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

inline

Return the job UUID as a string.

{ return boost::uuids::to_string(job_uuid); };

jobname()

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

inline

Return the job name.

{ return jobnm; };

new_newid()

std::string mspass::utility::ProcessManager::new_newid ( )

inline

Get a new UUID to define unique job run.

MsPASS data objects are tagged with a UUID to properly handle processing history. Procedures can call his method to get a uuid based on boost's random_generator. We keep the generator in this object because web conversations suggest construction of random_generator is expensive in time and needs to not be done at the object level.

Returns

new uuid definign this job in string form.

                        {
    boost::uuids::uuid id;
    id = gen();
    return boost::uuids::to_string(id);
  }

---

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

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