Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Member Functions | Protected Attributes | List of all members
core::io::raw_data::RawFileData Class Reference

Abstract base class for classes that writes different types of silent-files that contain a mixture of Struct objects which are expected to be uniquely identified by some sort of string-based tag. More...

#include <RawFileData.hh>

Inheritance diagram for core::io::raw_data::RawFileData:
Inheritance graph
[legend]

Classes

class  const_iterator
 const_iterator class for RawFileData container. More...
 
class  iterator
 Iterator class for RawFileData container. More...
 

Public Member Functions

 RawFileData ()
 
virtual ~RawFileData ()
 Destructor. More...
 
int size () const
 Returns the number of structures contained in this container. More...
 
int nres () const
 Returns the number of residues in the first structure in this object. Not guaranteed to be fixed for all structures in this container. More...
 
std::string sequence () const
 Returns the sequence of the first structure in this object. Not guaranteed to be fixed for all structures in this container. More...
 
void clear_structure_map ()
 Remove all of the RawStruct objects from this object. More...
 
utility::vector1< std::string > read_tags_fast (std::string const &filename) const
 quickly read a list of tags from a silent-input file. Only checks lines beginning with SCORE: strings. More...
 
void write_all (std::string const &filename, std::map< std::string, core::Real > const &score_map)
 write all RawStruct objects in the structure_map_ to the given filename. More...
 
iterator begin ()
 Returns an iterator to the start of the members of this container. More...
 
iterator end ()
 Returns an iterator to the end of the members of this container. More...
 
const_iterator begin_const () const
 
const_iterator end_const () const
 

Protected Attributes

StructureMap structure_map_
 
std::string sequence_
 

Detailed Description

Abstract base class for classes that writes different types of silent-files that contain a mixture of Struct objects which are expected to be uniquely identified by some sort of string-based tag.

Constructor & Destructor Documentation

core::io::raw_data::RawFileData::RawFileData ( )
inline
virtual core::io::raw_data::RawFileData::~RawFileData ( )
inlinevirtual

Destructor.

References clear_structure_map().

Member Function Documentation

iterator core::io::raw_data::RawFileData::begin ( )
inline

Returns an iterator to the start of the members of this container.

References structure_map_.

Referenced by write_all().

const_iterator core::io::raw_data::RawFileData::begin_const ( ) const
inline

References structure_map_.

Referenced by nres().

void core::io::raw_data::RawFileData::clear_structure_map ( )
inline

Remove all of the RawStruct objects from this object.

References structure_map_.

Referenced by ~RawFileData().

iterator core::io::raw_data::RawFileData::end ( )
inline

Returns an iterator to the end of the members of this container.

References structure_map_.

Referenced by write_all().

const_iterator core::io::raw_data::RawFileData::end_const ( ) const
inline

References structure_map_.

int core::io::raw_data::RawFileData::nres ( ) const
inline

Returns the number of residues in the first structure in this object. Not guaranteed to be fixed for all structures in this container.

References begin_const().

utility::vector1< std::string > core::io::raw_data::RawFileData::read_tags_fast ( std::string const &  filename) const

quickly read a list of tags from a silent-input file. Only checks lines beginning with SCORE: strings.

Referenced by protocols::jobdist::PlainRawJobDistributor::PlainRawJobDistributor().

std::string core::io::raw_data::RawFileData::sequence ( ) const
inline

Returns the sequence of the first structure in this object. Not guaranteed to be fixed for all structures in this container.

References sequence_.

int core::io::raw_data::RawFileData::size ( ) const
inline

Returns the number of structures contained in this container.

References structure_map_.

void core::io::raw_data::RawFileData::write_all ( std::string const &  filename,
std::map< std::string, core::Real > const &  score_map 
)

write all RawStruct objects in the structure_map_ to the given filename.

References begin(), and end().

Member Data Documentation

std::string core::io::raw_data::RawFileData::sequence_
protected

Referenced by sequence().

StructureMap core::io::raw_data::RawFileData::structure_map_
protected

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