Authorship information for an unpublished Rosetta module. More...

#include <UnpublishedModuleInfo.hh>

Inheritance diagram for basic::citation_manager::UnpublishedModuleInfo:

Public Member Functions
	UnpublishedModuleInfo ()=delete
	Default constructor, explicitly deleted. More...

	UnpublishedModuleInfo (std::string const &module_name, CitedModuleType const &module_type)
	Initialization constructor. More...

	UnpublishedModuleInfo (std::string const &module_name, CitedModuleType const &module_type, std::string const &author_name, std::string const &affiliation, std::string const &email)
	Initialization constructor with single author. More...

	UnpublishedModuleInfo (std::string const &module_name, CitedModuleType const &module_type, std::string const &author_name, std::string const &affiliation, std::string const &email, std::string const &notes)
	Initialization constructor with single author. More...

	UnpublishedModuleInfo (std::string const &module_name, std::string const &module_type_name)
	Initialization constructor for CustomTypes. More...

	UnpublishedModuleInfo (UnpublishedModuleInfo const &)=default
	Copy constructor. More...

	~UnpublishedModuleInfo () override=default
	Destructor. More...

bool	operator== (CitationCollectionBase const &other) const override
	Comparison operator, generalized on the base class. More...

bool	operator== (UnpublishedModuleInfo const &other) const
	Comparison operator. More...

UnpublishedModuleInfoOP	clone () const
	Clone operation: make a copy of this object, and return an owning pointer to the copy. More...

std::string const &	module_name () const
	Get the unpublished module's name. More...

std::string const &	module_type () const
	Get the unpublished module's type. More...

void	add_author (std::string const &author_name, std::string const &affiliation, std::string const &email)
	Add an author for this unpublished module. More...

void	add_author (std::string const &author_name, std::string const &affiliation, std::string const &email, std::string const &notes)
	Add an author for this unpublished module. More...

void	get_author_list (std::ostream &outstream) const
	List authors in the format: Name, Institution <email> Name, Institution <email> Name, Institution <email> ... More...

Public Member Functions inherited from utility::VirtualBase
	VirtualBase ()=default
	Default constructor. More...

virtual	~VirtualBase ()=default
	The virtual destructor is one of the main reasons for the VirtualBase class. More...

	VirtualBase (VirtualBase const &)=default

	VirtualBase (VirtualBase &&)=default

VirtualBase &	operator= (VirtualBase const &)=default

VirtualBase &	operator= (VirtualBase &&)=default

Private Attributes
utility::vector1 < UnpublishedModuleAuthorCOP >	authors_
	Information about all of the authors. More...

std::string	module_name_
	The name of the unpublished module. More...

CitedModuleType	module_type_
	The type of the unpublished module. More...

std::string	module_type_name_
	The name of the unpublished module type, if it's a CustomType. More...

Detailed Description

Authorship information for an unpublished Rosetta module.

Author: Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

Constructor & Destructor Documentation

basic::citation_manager::UnpublishedModuleInfo::UnpublishedModuleInfo ( )

delete

Default constructor, explicitly deleted.

basic::citation_manager::UnpublishedModuleInfo::UnpublishedModuleInfo	(	std::string const &	module_name,
		CitedModuleType const &	module_type
	)

Initialization constructor.

Cannot be CustomType.

References basic::citation_manager::CustomType, module_name_, module_type_, and runtime_assert.

basic::citation_manager::UnpublishedModuleInfo::UnpublishedModuleInfo	(	std::string const &	module_name,
		CitedModuleType const &	module_type,
		std::string const &	author_name,
		std::string const &	affiliation,
		std::string const &	email
	)

Initialization constructor with single author.

Cannot be CustomType.

References basic::citation_manager::CustomType, module_name_, module_type_, and runtime_assert.

basic::citation_manager::UnpublishedModuleInfo::UnpublishedModuleInfo	(	std::string const &	module_name,
		CitedModuleType const &	module_type,
		std::string const &	author_name,
		std::string const &	affiliation,
		std::string const &	email,
		std::string const &	notes
	)

Initialization constructor with single author.

Cannot be CustomType. This version has a field for notes.

References basic::citation_manager::CustomType, module_name_, module_type_, and runtime_assert.

basic::citation_manager::UnpublishedModuleInfo::UnpublishedModuleInfo	(	std::string const &	module_name,
		std::string const &	module_type_name
	)

Initialization constructor for CustomTypes.

References basic::citation_manager::CustomType, module_name_, module_type_name_, and runtime_assert.

basic::citation_manager::UnpublishedModuleInfo::UnpublishedModuleInfo ( UnpublishedModuleInfo const & )

default

Copy constructor.

basic::citation_manager::UnpublishedModuleInfo::~UnpublishedModuleInfo ( )

overridedefault

Destructor.

Member Function Documentation

void basic::citation_manager::UnpublishedModuleInfo::add_author	(	std::string const &	author_name,
		std::string const &	affiliation,
		std::string const &	email
	)

Add an author for this unpublished module.

The author name must be nonempty; the other fields may be empty.

References authors_.

void basic::citation_manager::UnpublishedModuleInfo::add_author	(	std::string const &	author_name,
		std::string const &	affiliation,
		std::string const &	email,
		std::string const &	notes
	)

Add an author for this unpublished module.

The author name must be nonempty; the other fields may be empty. This version has a field for notes.

References authors_.

UnpublishedModuleInfoOP basic::citation_manager::UnpublishedModuleInfo::clone ( ) const

Clone operation: make a copy of this object, and return an owning pointer to the copy.

void basic::citation_manager::UnpublishedModuleInfo::get_author_list ( std::ostream & outstream ) const

List authors in the format: Name, Institution <email> Name, Institution <email> Name, Institution <email> ...

References conf::author, and authors_.

std::string const& basic::citation_manager::UnpublishedModuleInfo::module_name ( ) const

inline

Get the unpublished module's name.

References module_name_.

std::string const & basic::citation_manager::UnpublishedModuleInfo::module_type ( ) const

Get the unpublished module's type.

References basic::citation_manager::CustomType, basic::citation_manager::CitationCollection::get_enumerated_module_type_name(), module_type_, and module_type_name_.

bool basic::citation_manager::UnpublishedModuleInfo::operator== ( CitationCollectionBase const & other ) const

overridevirtual

Comparison operator, generalized on the base class.

Checks if both are UnpublishedModuleInfo, and if so defers to the operator== below.

Implements basic::citation_manager::CitationCollectionBase.

bool basic::citation_manager::UnpublishedModuleInfo::operator== ( UnpublishedModuleInfo const & other ) const

Comparison operator.

References module_name_, module_type_, and module_type_name_.

Member Data Documentation

utility::vector1< UnpublishedModuleAuthorCOP > basic::citation_manager::UnpublishedModuleInfo::authors_

private

Information about all of the authors.

Referenced by add_author(), and get_author_list().

std::string basic::citation_manager::UnpublishedModuleInfo::module_name_

private

The name of the unpublished module.

Referenced by module_name(), operator==(), and UnpublishedModuleInfo().

CitedModuleType basic::citation_manager::UnpublishedModuleInfo::module_type_

private

The type of the unpublished module.

Referenced by module_type(), operator==(), and UnpublishedModuleInfo().

std::string basic::citation_manager::UnpublishedModuleInfo::module_type_name_

private

The name of the unpublished module type, if it's a CustomType.

Referenced by module_type(), operator==(), and UnpublishedModuleInfo().

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

src/basic/citation_manager/UnpublishedModuleInfo.hh
src/basic/citation_manager/UnpublishedModuleInfo.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation