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:

Collaboration diagram for core::io::raw_data::RawFileData:

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 (const std::string 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.

Definition at line 39 of file RawFileData.hh.

Constructor & Destructor Documentation

core::io::raw_data::RawFileData::RawFileData ( )

inline

Definition at line 44 of file RawFileData.hh.

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

inlinevirtual

Destructor.

Definition at line 47 of file RawFileData.hh.

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.

Definition at line 178 of file RawFileData.hh.

References structure_map_.

Referenced by write_all().

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

inline

Definition at line 182 of file RawFileData.hh.

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.

Definition at line 67 of file RawFileData.hh.

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.

Definition at line 180 of file RawFileData.hh.

References structure_map_.

Referenced by write_all().

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

inline

Definition at line 183 of file RawFileData.hh.

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.

Definition at line 56 of file RawFileData.hh.

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.

Definition at line 37 of file RawFileData.cc.

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.

Definition at line 62 of file RawFileData.hh.

References sequence_.

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

inline

Returns the number of structures contained in this container.

Definition at line 52 of file RawFileData.hh.

References structure_map_.

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

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

Definition at line 64 of file RawFileData.cc.

References begin(), end(), and protocols::swa::rna::file_exists().

Member Data Documentation

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

protected

Definition at line 82 of file RawFileData.hh.

Referenced by sequence().

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

protected

Definition at line 81 of file RawFileData.hh.

Referenced by begin(), begin_const(), clear_structure_map(), end(), end_const(), and size().

---

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

• src/core/io/raw_data/RawFileData.hh
• src/core/io/raw_data/RawFileData.cc