Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Functions | Variables
basic::resource_manager::locator Namespace Reference

Classes

class  DatabaseResourceLocator
 The DatabaseResourceLocator class is responsible for retreiving data from a Database so that that data can then be used to construct a Resource. More...
 
class  DatabaseResourceLocatorCreator
 creator for the DatabaseResourceLocator class More...
 
class  FileListResourceLocator
 The FileListResourceLocator concatenates a set of listed files; e.g. useful for constructing a pose from two separate PDB files. More...
 
class  FileListResourceLocatorCreator
 creator for the FileSystemResourceLocator class More...
 
class  FileStream
 FileStream is a wrapper class for a utility::io::izstream object that derives from ResourceStream. More...
 
class  FileSystemResourceLocator
 The FileSystemResourceLocator is responsible for opening a file from the file system given its name (as the "locator tag" in the locate_resource_stream method ) and returning a FileStream object that wraps this file. This FileStream can then be used to construct a resource. More...
 
class  FileSystemResourceLocatorCreator
 creator for the FileSystemResourceLocator class More...
 
class  NullResourceLocator
 The NullResourceLocator is meant for cases where a resource can be created without reading from an input file. It goes through the motions of returning a ResourceStream (an empty NullStream) as is required of all ResourceLocators, but the stream that it creates will not be used. More...
 
class  NullResourceLocatorCreator
 creator for the NullResourceLocator class More...
 
class  NullStream
 The NullStream acts as an empty stream object that may be returned by the NullResourceLocator. It does not open any files. More...
 
class  StringResourceStream
 The StringResourceStream is a wrapper class for a std::stringstream that can be used to construct a resource. Useful when reading the resource stream in to memory (e.g. from a database or from multiple files) before trying to construct the resource. More...
 

Typedefs

typedef
utility::pointer::shared_ptr
< FileStream
FileStreamOP
 
typedef
utility::pointer::shared_ptr
< FileStream const > 
FileStreamCOP
 
typedef
utility::pointer::shared_ptr
< DatabaseResourceLocator
DatabaseResourceLocatorOP
 
typedef
utility::pointer::shared_ptr
< DatabaseResourceLocator
const > 
DatabaseResourceLocatorCOP
 
typedef
utility::pointer::shared_ptr
< FileListResourceLocator
FileListResourceLocatorOP
 
typedef
utility::pointer::shared_ptr
< FileListResourceLocator
const > 
FileListResourceLocatorCOP
 
typedef
utility::pointer::shared_ptr
< FileSystemResourceLocator
FileSystemResourceLocatorOP
 
typedef
utility::pointer::shared_ptr
< FileSystemResourceLocator
const > 
FileSystemResourceLocatorCOP
 
typedef
utility::pointer::shared_ptr
< NullStream
NullStreamOP
 
typedef
utility::pointer::shared_ptr
< NullStream const > 
NullStreamCOP
 
typedef
utility::pointer::shared_ptr
< NullResourceLocator
NullResourceLocatorOP
 
typedef
utility::pointer::shared_ptr
< NullResourceLocator const > 
NullResourceLocatorCOP
 
typedef
utility::pointer::shared_ptr
< StringResourceStream
StringResourceStreamOP
 
typedef
utility::pointer::shared_ptr
< StringResourceStream const > 
StringResourceStreamCOP
 

Functions

void xsd_type_definition_w_attributes (utility::tag::XMLSchemaDefinition &xsd, std::string const &locator_type, std::string const &description, utility::tag::AttributeList const &attributes)
 Define the XML schema definition for a ResourceLocator that contains no subtags but may contain any number of attributes (aka options). More...
 
void xsd_type_definition_w_attributes_and_repeatable_subelements (utility::tag::XMLSchemaDefinition &xsd, std::string const &locator_type, std::string const &description, utility::tag::AttributeList const &attributes, utility::tag::XMLSchemaSimpleSubelementList const &subelements)
 Define the XML schema definition for a ResourceLocator that contains subtags and attributes (aka options). More...
 

Variables

static Tracer TR ("basic.resource_manager.locator.DatabaseResourceLocator")
 
static Tracer file_list_tracer ("basic.resource_manager.locator.FileListResourceLocator")
 
static Tracer TR ("basic.resource_manager.locator.FileSystemResourceLocator")
 
static Tracer TR ("basic.resource_manager.locator.NullResourceLocator")
 

Typedef Documentation

Function Documentation

void basic::resource_manager::locator::xsd_type_definition_w_attributes ( utility::tag::XMLSchemaDefinition xsd,
std::string const &  locator_type,
std::string const &  description,
utility::tag::AttributeList const &  attributes 
)
void basic::resource_manager::locator::xsd_type_definition_w_attributes_and_repeatable_subelements ( utility::tag::XMLSchemaDefinition xsd,
std::string const &  locator_type,
std::string const &  description,
utility::tag::AttributeList const &  attributes,
utility::tag::XMLSchemaSimpleSubelementList const &  subelements 
)

Variable Documentation

Tracer basic::resource_manager::locator::file_list_tracer("basic.resource_manager.locator.FileListResourceLocator")
static
Tracer basic::resource_manager::locator::TR("basic.resource_manager.locator.NullResourceLocator")
static
Tracer basic::resource_manager::locator::TR("basic.resource_manager.locator.FileSystemResourceLocator")
static
Tracer basic::resource_manager::locator::TR("basic.resource_manager.locator.DatabaseResourceLocator")
static