colvarmodule::usage Class Reference

Track usage of Colvars features. More...

Collaboration diagram for colvarmodule::usage:

Public Member Functions
	usage (colvarmodule *cvmodule_in)
	Constructor.
int	cite_feature (std::string const &feature)
	Increment usage count for the given feature; return error if not found.
int	cite_paper (std::string const &paper)
	Increment usage count for the given paper; return error if not found.
std::string	report (int flag)
	Generate a report for used features (0 = URL, 1 = BibTeX)

Public Attributes
colvarmodule *	cvmodule

Protected Attributes
std::map< std::string, int >	feature_count_
	Usage count for each feature.
std::map< std::string, int >	paper_count_
	Usage count for each cited paper.
std::map< std::string, std::string >	paper_url_
	URL for each paper.
std::map< std::string, std::string >	paper_bibtex_
	BibTeX entry for each paper.
std::map< std::string, std::string >	feature_paper_map_
	Map code features to the relevant papers.

Detailed Description

Track usage of Colvars features.

---

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

• colvarmodule.cpp