Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
basic::citation_manager::CitationCollectionList Class Reference

A collection of CitationCollectionBases. More...

#include <CitationCollectionBase.hh>

Inheritance diagram for basic::citation_manager::CitationCollectionList:
Inheritance graph
[legend]

Public Member Functions

utility::vector1
< CitationCollectionBaseCOP >
const & 
citations () const
 The list of citation collections as a vector. More...
 
bool empty () const
 Are we empty of citations? More...
 
void add (CitationCollectionBaseCOP const &citr)
 Add the citation to the list, being aware of duplicates. More...
 
void add (CitationCollectionList const &other)
 Add all the citations in the other list. More...
 
template<class T >
void add (utility::vector1< T > const &other)
 Add all the citations in the other list. More...
 
template<class T >
std::enable_if
< std::is_member_function_pointer
< decltype(&T::provide_citation_info) >
::value, void >::type 
add (utility::pointer::shared_ptr< T > const &ptr)
 Convenience function for safely getting citation info from a member OP. More...
 
template<class T >
std::enable_if
< std::is_member_function_pointer
< decltype(&T::provide_citation_info) >
::value, void >::type 
add (T const &obj)
 Convenience function for getting citation info from another object. 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
 
VirtualBaseoperator= (VirtualBase const &)=default
 
VirtualBaseoperator= (VirtualBase &&)=default
 

Private Attributes

utility::vector1
< CitationCollectionBaseCOP
entries_
 

Detailed Description

A collection of CitationCollectionBases.

Member Function Documentation

void basic::citation_manager::CitationCollectionList::add ( CitationCollectionBaseCOP const &  citr)
void basic::citation_manager::CitationCollectionList::add ( CitationCollectionList const &  other)

Add all the citations in the other list.

References add(), and entries_.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

template<class T >
void basic::citation_manager::CitationCollectionList::add ( utility::vector1< T > const &  other)
inline

Add all the citations in the other list.

References add().

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

template<class T >
std::enable_if< std::is_member_function_pointer< decltype(&T::provide_citation_info) >::value, void>::type basic::citation_manager::CitationCollectionList::add ( utility::pointer::shared_ptr< T > const &  ptr)
inline

Convenience function for safely getting citation info from a member OP.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

template<class T >
std::enable_if< std::is_member_function_pointer< decltype(&T::provide_citation_info) >::value, void>::type basic::citation_manager::CitationCollectionList::add ( T const &  obj)
inline

Convenience function for getting citation info from another object.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

utility::vector1< CitationCollectionBaseCOP > const & basic::citation_manager::CitationCollectionList::citations ( ) const

The list of citation collections as a vector.

References entries_.

Referenced by basic::citation_manager::CitationManager::split_citations().

bool basic::citation_manager::CitationCollectionList::empty ( ) const

Member Data Documentation

utility::vector1< CitationCollectionBaseCOP > basic::citation_manager::CitationCollectionList::entries_
private

Referenced by add(), citations(), and empty().


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