basic::resource_manager::locator::FileListResourceLocator Class Reference

The FileListResourceLocator concatenates a set of listed files; e.g. useful for constructing a pose from two separate PDB files. More...

#include <FileListResourceLocator.hh>

Inheritance diagram for basic::resource_manager::locator::FileListResourceLocator:

Public Member Functions
	FileListResourceLocator ()
void	show (std::ostream &out) const override
	Describe the FileListResourceLocator to the output stringstream; since this class has no data, merely prints the name of the class. More...
std::string	type () const override
	Return the name for this class: "FileListResourceLocator". More...
void	set_open_mode (std::ios_base::openmode open_mode)
std::ios_base::openmode	get_open_mode () const
ResourceStreamOP	locate_resource_stream (std::string const &input_id) const override
	Take the input locator tag and split it by whitespace, interpret each substring as the name of a file, and concatenate each file into a single stringstream to be returned. More...
void	parse_my_tag (utility::tag::TagCOP tag) override
	Do nothing, since there is no data that the FileListResourceLocator needs. More...
Public Member Functions inherited from basic::resource_manager::ResourceLocator
	ResourceLocator ()
	Construct a ResourceLocator and initialize its name (its locator_tag) to the empty string. More...
	ResourceLocator (std::string const &locator_tag)
	Construct a ResourceLocator while setting its name to the input locater_tag. More...
	ResourceLocator (ResourceLocator const &src)
	Copy construct a ResourceLocator from an example locator. More...
	~ResourceLocator () override
virtual void	locator_tag (std::string const &locator_tag)
	Set the name for this ResourceLocator. More...
virtual std::string	locator_tag () const
	Return the name for this ResourceLocator. 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
VirtualBase &	operator= (VirtualBase const &)=default
VirtualBase &	operator= (VirtualBase &&)=default

Static Public Member Functions
static std::string	classname ()
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
	Describe the schema for this resource locator to the XSD. More...

Private Attributes
std::ios_base::openmode	open_mode_

Detailed Description

The FileListResourceLocator concatenates a set of listed files; e.g. useful for constructing a pose from two separate PDB files.

Constructor & Destructor Documentation

basic::resource_manager::locator::FileListResourceLocator::FileListResourceLocator

(

)

Member Function Documentation

std::string basic::resource_manager::locator::FileListResourceLocator::classname ( )

static

Referenced by basic::resource_manager::locator::FileListResourceLocatorCreator::locator_type(), provide_xml_schema(), and type().

std::ios_base::openmode basic::resource_manager::locator::FileListResourceLocator::get_open_mode

(

)

const

References open_mode_.

ResourceStreamOP basic::resource_manager::locator::FileListResourceLocator::locate_resource_stream ( std::string const &  input_id ) const

overridevirtual

Take the input locator tag and split it by whitespace, interpret each substring as the name of a file, and concatenate each file into a single stringstream to be returned.

Implements basic::resource_manager::ResourceLocator.

References ObjexxFCL::getline(), line, open_mode_, basic::resource_manager::locator::FileStream::stream(), and utility::string_split().

void basic::resource_manager::locator::FileListResourceLocator::parse_my_tag ( utility::tag::TagCOP  tag )

overridevirtual

Do nothing, since there is no data that the FileListResourceLocator needs.

Implements basic::resource_manager::ResourceLocator.

void basic::resource_manager::locator::FileListResourceLocator::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

Describe the schema for this resource locator to the XSD.

References classname(), tag, and basic::resource_manager::locator::xsd_type_definition_w_attributes().

Referenced by basic::resource_manager::locator::FileListResourceLocatorCreator::provide_xml_schema().

void basic::resource_manager::locator::FileListResourceLocator::set_open_mode

(

std::ios_base::openmode

open_mode

)

References open_mode_.

void basic::resource_manager::locator::FileListResourceLocator::show ( std::ostream &  out ) const

overridevirtual

Describe the FileListResourceLocator to the output stringstream; since this class has no data, merely prints the name of the class.

Implements basic::resource_manager::ResourceLocator.

Referenced by pyrosetta.distributed.viewer.core.Viewer::__call__().

std::string basic::resource_manager::locator::FileListResourceLocator::type ( ) const

overridevirtual

Return the name for this class: "FileListResourceLocator".

Implements basic::resource_manager::ResourceLocator.

References classname().

Member Data Documentation

std::ios_base::openmode basic::resource_manager::locator::FileListResourceLocator::open_mode_

private

Referenced by get_open_mode(), locate_resource_stream(), and set_open_mode().

---

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

• src/basic/resource_manager/locator/FileListResourceLocator.hh
• src/basic/resource_manager/locator/FileListResourceLocator.cc