stormm::topology::Citation Class Reference

A means for numbering and tracking citations or other documented sources of information. More...

#include <citation.h>

Public Member Functions
	Citation (const std::string &byline_in, int index_in=0)
	Constructor can take all attributes, but prioritizes the byline and index.
int	getCitationIndex () const
	Get the citation number.
std::string	getByline () const
	Get the byline.
void	addAuthor (const std::string &author_in)
	Add one author to the citation.
void	addAuthors (const std::vector< std::string > &authors_in)
	Add multiple authors to the citation.
void	addEditor (const std::string &editor_in)
	Add one editor to the citation.
void	addEditors (const std::vector< std::string > &editors_in)
	Add multiple editors to the citation.
void	addTitle (const std::string &title_in)
	Add the title of the publication or book.
void	addJournal (const std::string &journal_in)
	Add the name of the journal (if applicable)
void	addPublisher (const std::string &publisher_in)
	Add the name of the publisher (if applicable)
void	addVolume (int volume_in)
	Add the journal volume.
void	addIssue (int issue_in)
	Add the journal issue.
void	addStartPage (int page_start_in)
	Add the starting page (for a journal or book)
void	addEndPage (int page_end_in)
	Add the ending page (for a journal or book)
void	addYear (int year_in)
	Add the year of publication.
void	addDoI (const std::string &part_a, const std::string &part_b)
	Add the digital object identifier.

Detailed Description

A means for numbering and tracking citations or other documented sources of information.

Member Function Documentation

addAuthor()

void stormm::parse::Citation::addAuthor

(

const std::string &

author_in

)

Add one author to the citation.

Parameters

author_in

Name of the author to add (a full name is entered as one string)

addAuthors()

void stormm::parse::Citation::addAuthors

(

const std::vector< std::string > &

authors_in

)

Add multiple authors to the citation.

Parameters

authors_in

Names of the authors to add (a full name is entered as one string)

addDoI()

void stormm::parse::Citation::addDoI	(	const std::string &	part_a,
		const std::string &	part_b )

Add the digital object identifier.

Parameters

part_a	First part of the DOI
part_b	Second part of the DOI

addEditor()

void stormm::parse::Citation::addEditor

(

const std::string &

editor_in

)

Add one editor to the citation.

Parameters

editor_in

Name of the editor to add (a full name is entered as one string)

addEditors()

void stormm::parse::Citation::addEditors

(

const std::vector< std::string > &

editors_in

)

Add multiple editors to the citation.

Parameters

editors_in

Names of the editors to add (a full name is entered as one string)

addEndPage()

void stormm::parse::Citation::addEndPage

(

int

page_end_in

)

Add the ending page (for a journal or book)

Parameters

page_end_in

The ending page number

addIssue()

void stormm::parse::Citation::addIssue

(

int

issue_in

)

Add the journal issue.

Parameters

issue_in

The journal issue number

addJournal()

void stormm::parse::Citation::addJournal

(

const std::string &

journal_in

)

Add the name of the journal (if applicable)

Parameters

journal_in

The journal name to add

addPublisher()

void stormm::parse::Citation::addPublisher

(

const std::string &

publisher_in

)

Add the name of the publisher (if applicable)

Parameters

publisher_in

The publisher name to add

addStartPage()

void stormm::parse::Citation::addStartPage

(

int

page_start_in

)

Add the starting page (for a journal or book)

Parameters

page_start_in

The starting page number

addTitle()

void stormm::parse::Citation::addTitle

(

const std::string &

title_in

)

Add the title of the publication or book.

Parameters

title_in

The title to add

addVolume()

void stormm::parse::Citation::addVolume

(

int

volume_in

)

Add the journal volume.

Parameters

volume_in

The journal volume number

addYear()

void stormm::parse::Citation::addYear

(

int

year_in

)

Add the year of publication.

Parameters

year_in

The year that the piece was published

---

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

• src/Parsing/citation.h
• src/Parsing/citation.cpp