Rosetta  2020.46
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
protocols::jd3::InputSource Class Reference

The InputSource is a small class for holding data about the starting Pose for a Job and where it comes from (i.e. which of the Inputters claims responsibility for creating a Pose for this instance). The "input_tag" is a string description of the input source and will be used as the "job_tag" to control output – the input tag should not include the file extension. It is perfectly reasonable for complex Inputters to subclass from InputSource to tuck more complex data in the InputSource, though, the string-string map ought to provide considerable flexibility in storing data without deriving new subclasses. More...

#include <InputSource.hh>

Inheritance diagram for protocols::jd3::InputSource:
Inheritance graph
[legend]

Public Member Functions

 InputSource ()
 
 InputSource (std::string origin)
 
 ~InputSource () override
 
bool operator== (InputSource const &rhs) const
 
bool operator!= (InputSource const &rhs) const
 
bool operator< (InputSource const &rhs) const
 
std::string const & input_tag () const
 
std::string const & origin () const
 
core::Size source_id () const
 
void input_tag (std::string const &setting)
 
void origin (std::string const &setting)
 
void source_id (core::Size setting)
 

Private Attributes

std::string origin_
 
std::string input_tag_
 
core::Size source_id_ = 0
 

Detailed Description

The InputSource is a small class for holding data about the starting Pose for a Job and where it comes from (i.e. which of the Inputters claims responsibility for creating a Pose for this instance). The "input_tag" is a string description of the input source and will be used as the "job_tag" to control output – the input tag should not include the file extension. It is perfectly reasonable for complex Inputters to subclass from InputSource to tuck more complex data in the InputSource, though, the string-string map ought to provide considerable flexibility in storing data without deriving new subclasses.

Constructor & Destructor Documentation

protocols::jd3::InputSource::InputSource ( )
protocols::jd3::InputSource::InputSource ( std::string  origin)
protocols::jd3::InputSource::~InputSource ( )
overridedefault

Member Function Documentation

std::string const & protocols::jd3::InputSource::input_tag ( ) const
void protocols::jd3::InputSource::input_tag ( std::string const &  setting)

References input_tag_.

bool protocols::jd3::InputSource::operator!= ( InputSource const &  rhs) const
bool protocols::jd3::InputSource::operator< ( InputSource const &  rhs) const

References input_tag_, origin_, and source_id_.

bool protocols::jd3::InputSource::operator== ( InputSource const &  rhs) const

References input_tag_, origin_, and source_id_.

std::string const & protocols::jd3::InputSource::origin ( ) const

References origin_.

void protocols::jd3::InputSource::origin ( std::string const &  setting)

References origin_.

core::Size protocols::jd3::InputSource::source_id ( ) const
void protocols::jd3::InputSource::source_id ( core::Size  setting)

References source_id_.

Member Data Documentation

std::string protocols::jd3::InputSource::input_tag_
private

Referenced by input_tag(), operator<(), and operator==().

std::string protocols::jd3::InputSource::origin_
private

Referenced by operator<(), operator==(), and origin().

core::Size protocols::jd3::InputSource::source_id_ = 0
private

Referenced by operator<(), operator==(), and source_id().


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