CitationInfo Namespace Reference

Functions
const std::string	get_url_part ()
void	add (const std::string &id)
template<class Stream >
void	print_info_block (Stream &stream)

Detailed Description

A namespace to provide information to the user about stuff to cite.

Function Documentation

get_url_part()

const std::string CitationInfo::get_url_part

(

)

Get the URL in the format "citing.html?(parameters)" that describes how to cite ASPECT based on the current model you are running.

Referenced by print_info_block().

add()

void CitationInfo::add

(

const std::string &

id

)

Add the paper identified by the given id to the currently used list of papers. See citing.html for the list of ids. For specific features inside ASPECT that have associated publications, call this function if the feature is used in the current computation. For example, if the computation requires melt migration, call add("melt").

print_info_block()

template<class Stream >

void CitationInfo::print_info_block

(

Stream &

stream

)

Print the info text containing the citation info into the given stream.

Definition at line 52 of file citation_info.h.

References get_url_part().