Rerunable Class Reference

#include <rerunable_program.h>

Inheritance diagram for Rerunable:

Protected Member Functions
	Rerunable (const FileName &fn)
virtual void	createWorkFiles (bool resume, MetaData *md)
virtual std::vector< MDLabel >	getLabelsForEmpty ()=0
const FileName &	getFileName () const
void	setFileName (const FileName &fn)

Detailed Description

This class adds rerun functionality to Xmipp program. Program is expected to store the progres in the MetaData file stored in the file system. In case of failure or interruption, this file can be loaded and the program will automatically pick up where it left.

Definition at line 38 of file rerunable_program.h.

Constructor & Destructor Documentation

Rerunable()

Rerunable::Rerunable ( const FileName &  fn )

inlineprotected

Definition at line 43 of file rerunable_program.h.

: fnDone(fn) {}

Member Function Documentation

createWorkFiles()

virtual void Rerunable::createWorkFiles ( bool  resume, MetaData *  md  )

inlineprotectedvirtual

This method will fill remove processed records from the md. Md will not be changed if no data has been processed.

Definition at line 49 of file rerunable_program.h.

                                                          {
    if (nullptr == md) {
      REPORT_ERROR(ERR_MD,
                   "Null pointer passed. "
                   "If you can reproduce this, please contact developers.");
    }
    if (resume && fnDone.exists()) {
      MetaDataDb done(fnDone);
      auto *toDo = dynamic_cast<MetaDataDb *>(md);
      if (nullptr == toDo) {
        MetaDataDb tmp(*md);
        tmp.subtraction(done, MDL_IMAGE);
        *md = tmp;
      } else {
        toDo->subtraction(done, MDL_IMAGE);
      }
    } else // if not exists create metadata only with headers
    {
      MetaDataVec mdDone;
      for (const auto &l : this->getLabelsForEmpty()) {
        mdDone.addLabel(l);
      }
      mdDone.write(fnDone);
    }
  }

getFileName()

const FileName& Rerunable::getFileName ( ) const

inlineprotected

Definition at line 80 of file rerunable_program.h.

{ return this->fnDone; }

getLabelsForEmpty()

virtual std::vector<MDLabel> Rerunable::getLabelsForEmpty ( )

protectedpure virtual

Returns labels to be used in the empty progres MetaData file

setFileName()

void Rerunable::setFileName ( const FileName &  fn )

inlineprotected

Definition at line 82 of file rerunable_program.h.

{ fnDone = fn; }

---

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

• xmippCore/core/rerunable_program.h