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

The PoseInputSource is a small class for holding data about the starting Pose for a Job and where it comes from (i.e. which of the PoseInputters 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 PoseInputters to subclass from PoseInputSource to tuck more complex data in the PoseInputSource, though, the string-string map ought to provide considerable flexibility in storing data without deriving new subclasses. More...

#include <PoseInputSource.hh>

Inheritance diagram for protocols::jd3::pose_inputters::PoseInputSource:
Inheritance graph
[legend]

Public Types

typedef std::map< std::string,
std::string > 
StringStringMap
 

Public Member Functions

 PoseInputSource ()
 
 PoseInputSource (std::string origin)
 
bool operator== (PoseInputSource const &rhs) const
 
bool operator!= (PoseInputSource const &rhs) const
 
bool operator< (PoseInputSource const &rhs) const
 
StringStringMap const & string_string_map () const
 
void store_string_pair (std::string const &key, std::string const &value)
 
- Public Member Functions inherited from protocols::jd3::InputSource
 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_
 
StringStringMap string_string_map_
 
core::Size pose_id_
 

Detailed Description

The PoseInputSource is a small class for holding data about the starting Pose for a Job and where it comes from (i.e. which of the PoseInputters 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 PoseInputters to subclass from PoseInputSource to tuck more complex data in the PoseInputSource, though, the string-string map ought to provide considerable flexibility in storing data without deriving new subclasses.

Member Typedef Documentation

typedef std::map< std::string, std::string > protocols::jd3::pose_inputters::PoseInputSource::StringStringMap

Constructor & Destructor Documentation

protocols::jd3::pose_inputters::PoseInputSource::PoseInputSource ( )
inline
protocols::jd3::pose_inputters::PoseInputSource::PoseInputSource ( std::string  origin)

Member Function Documentation

bool protocols::jd3::pose_inputters::PoseInputSource::operator!= ( PoseInputSource const &  rhs) const
bool protocols::jd3::pose_inputters::PoseInputSource::operator< ( PoseInputSource const &  rhs) const
bool protocols::jd3::pose_inputters::PoseInputSource::operator== ( PoseInputSource const &  rhs) const
void protocols::jd3::pose_inputters::PoseInputSource::store_string_pair ( std::string const &  key,
std::string const &  value 
)

References string_string_map_.

PoseInputSource::StringStringMap const & protocols::jd3::pose_inputters::PoseInputSource::string_string_map ( ) const

Member Data Documentation

std::string protocols::jd3::pose_inputters::PoseInputSource::input_tag_
private

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

std::string protocols::jd3::pose_inputters::PoseInputSource::origin_
private

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

core::Size protocols::jd3::pose_inputters::PoseInputSource::pose_id_
private

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

StringStringMap protocols::jd3::pose_inputters::PoseInputSource::string_string_map_
private

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