References for the methods used in a run. More...

Classes
struct	Reference
struct	Optional
	a reference that depends on the options of a calculator More...
struct	CalculatorEntry

Functions
void	Cite (const std::string &key)
	marks a reference as used (thread safe; unknown keys are printed as such)
std::vector< std::string >	Used ()
	the keys used so far, in the order of first use
void	Reset ()
const std::vector< Reference > &	References ()
	all references
bool	Exists (const std::string &key)
std::string	Format (const std::string &key)
	one line: text and DOI
std::string	Report ()
	the block printed at the end of a run (empty if nothing was cited)
CalculatorEntry	ForCalculator (const std::string &name)
	the references of a calculator or tool (empty for unknown names)
std::vector< std::string >	Calculators ()
	all calculators and tools of the table
std::string	CalculatorReport (const std::string &name)
	the text printed by –cite

Detailed Description

References for the methods used in a run.

The code that runs a method calls Cite with the key of its reference (the keys of the bibliography of the manual). The application prints the references used, in the order of first use, at the end of the run. The table of calculators gives the references every run of a calculator uses and those that depend on its options (printed by –cite).

Function Documentation

◆ CalculatorReport()

std::string votca::xtp::citations::CalculatorReport ( const std::string & name )

the text printed by –cite

Definition at line 339 of file citations.cc.

◆ Calculators()

std::vector< std::string > votca::xtp::citations::Calculators ( )

all calculators and tools of the table

Definition at line 330 of file citations.cc.

◆ Cite()

void votca::xtp::citations::Cite ( const std::string & key )

marks a reference as used (thread safe; unknown keys are printed as such)

Definition at line 289 of file citations.cc.

◆ Exists()

bool votca::xtp::citations::Exists ( const std::string & key )

Definition at line 273 of file citations.cc.

◆ ForCalculator()

CalculatorEntry votca::xtp::citations::ForCalculator ( const std::string & name )

the references of a calculator or tool (empty for unknown names)

Definition at line 324 of file citations.cc.

◆ Format()

std::string votca::xtp::citations::Format ( const std::string & key )

one line: text and DOI

Definition at line 279 of file citations.cc.

◆ References()

const std::vector< Reference > & votca::xtp::citations::References ( )

all references

Definition at line 126 of file citations.cc.

◆ Report()

std::string votca::xtp::citations::Report ( )

the block printed at the end of a run (empty if nothing was cited)

Definition at line 307 of file citations.cc.

◆ Reset()

void votca::xtp::citations::Reset ( )

Definition at line 302 of file citations.cc.

◆ Used()

std::vector< std::string > votca::xtp::citations::Used ( )

the keys used so far, in the order of first use

Definition at line 297 of file citations.cc.

Classes

Functions