cps::CommonArg Struct Reference
[Algorithm parameters]

A container for parameters common to all algorithms. More...

#include <common_arg.h>

List of all members.

Public Member Functions
	CommonArg (const char *l=0, const char *f=0)
	Optional initialisation with a filename and label.
void	set_filename (const char *s)
	Set the file name.
void	set_label (const char *s)
	Assign the label name.
	~CommonArg ()
Public Attributes
void *	results
char *	filename
char *	label

---

Detailed Description

A container for parameters common to all algorithms.

Definition at line 25 of file common_arg.h.

---

Constructor & Destructor Documentation

cps::CommonArg::CommonArg (  const char *  l = 0, const char *  f = 0 )  [inline]

Optional initialisation with a filename and label. Parameters: l  A label identifying this job. f  The name of a file to which to write results. Definition at line 35 of file common_arg.h.

cps::CommonArg::~CommonArg (   )  [inline]

Definition at line 72 of file common_arg.h. References cps::sfree().

---

Member Function Documentation

void cps::CommonArg::set_filename (  const char *  s  )  [inline]

Set the file name. Results produced by the algorithm are written to this file. Parameters: s  The name of the file Definition at line 49 of file common_arg.h. References cps::ERR, cps::Error::Pointer(), cps::sfree(), and cps::smalloc(). Referenced by cps::AlgMeas::RunTask().

void cps::CommonArg::set_label (  const char *  s  )  [inline]

Assign the label name. A label can be assigned to a algorithm run. Parameters: s  The label Definition at line 63 of file common_arg.h. References cps::ERR, cps::Error::Pointer(), cps::sfree(), and cps::smalloc().

---

Member Data Documentation

char* cps::CommonArg::filename

The name of a file to which to write results. Definition at line 42 of file common_arg.h. Referenced by cps::AlgWline::run(), cps::AlgTcharge::run(), cps::AlgApeSmear2::run(), cps::AlgOlegSmear::run(), cps::AlgHypSmear::run(), cps::AlgKineticSmear::run(), cps::AlgApeSmear::run(), and cps::AlgHQPotential::run().

char* cps::CommonArg::label

A label which uniquely identifies this task. Definition at line 43 of file common_arg.h.

void* cps::CommonArg::results

This can point to a string containing the name of a file to which to write results, or an object to which results might be passed. Definition at line 27 of file common_arg.h. Referenced by cps::QPropW::DoLinkSmear(), cps::QPropWGFLfuncSrc::QPropWGFLfuncSrc(), cps::AlgWspect::run(), cps::AlgWspectExtMeson::run(), cps::AlgNLStagMeson::run(), cps::AlgStagNonLocal::run(), cps::AlgStagNucleon::run(), cps::AlgStagMomMeson::run(), cps::AlgStagMeson::run(), cps::AlgStagQuark::run(), cps::AlgRect::run(), cps::QPropW::Run(), cps::AlgPlaq::run(), cps::AlgPbp::run(), cps::AlgHmc::run(), cps::AlgHmdR2::run(), cps::AlgHmdR::run(), cps::AlgHmcRHMC::run(), cps::AlgHmcQPQ::run(), cps::AlgHmcPhi::run(), cps::AlgEqState::run(), cps::AlgDens::run(), cps::AlgPbp::runPointSource(), and cps::AlgMeas::RunTask().

---

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

• include/alg/common_arg.h

---