---

colvarmodule::usage Class Reference

Track usage of Colvars features. More...

List of all members.

Public Methods
	usage ()
	Constructor. More...
int	cite_feature (std::string const &feature)
	Increment usage count for the given feature; return error if not found. More...
int	cite_paper (std::string const &paper)
	Increment usage count for the given paper; return error if not found. More...
std::string	report (int flag)
	Generate a report for used features (0 = URL, 1 = BibTeX). More...
Protected Attributes
std::map< std::string, int >	feature_count_
	Usage count for each feature. More...
std::map< std::string, int >	paper_count_
	Usage count for each cited paper. More...
std::map< std::string, std::string >	paper_url_
	URL for each paper. More...
std::map< std::string, std::string >	paper_bibtex_
	BibTeX entry for each paper. More...
std::map< std::string, std::string >	feature_paper_map_
	Map code features to the relevant papers. More...

---

Detailed Description

Track usage of Colvars features.

Definition at line 36 of file colvarmodule.C.

---

Constructor & Destructor Documentation

usage::usage (    )

Constructor. Definition at line 2269 of file colvarmodule.C.

---

Member Function Documentation

int usage::cite_feature (  std::string const &    feature )

Increment usage count for the given feature; return error if not found. Definition at line 2847 of file colvarmodule.C. Referenced by colvarmodule::cite_feature, and colvarmodule::colvarmodule.

int usage::cite_paper (  std::string const &    paper )

Increment usage count for the given paper; return error if not found. Definition at line 2857 of file colvarmodule.C.

std::string usage::report (  int    flag )

Generate a report for used features (0 = URL, 1 = BibTeX). Definition at line 2867 of file colvarmodule.C. Referenced by colvarmodule::feature_report.

---

Member Data Documentation

std::map<std::string, int> colvarmodule::usage::feature_count_ [protected]

Usage count for each feature. Definition at line 55 of file colvarmodule.C.

std::map<std::string, std::string> colvarmodule::usage::feature_paper_map_ [protected]

Map code features to the relevant papers. Definition at line 67 of file colvarmodule.C.

std::map<std::string, std::string> colvarmodule::usage::paper_bibtex_ [protected]

BibTeX entry for each paper. Definition at line 64 of file colvarmodule.C.

std::map<std::string, int> colvarmodule::usage::paper_count_ [protected]

Usage count for each cited paper. Definition at line 58 of file colvarmodule.C.

std::map<std::string, std::string> colvarmodule::usage::paper_url_ [protected]

URL for each paper. Definition at line 61 of file colvarmodule.C.

---

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

• colvarmodule.C

---