Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | List of all members
basic::resource_manager::locator::NullResourceLocator Class Reference

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...

#include <NullResourceLocator.hh>

Inheritance diagram for basic::resource_manager::locator::NullResourceLocator:
Inheritance graph
[legend]

Public Member Functions

 NullResourceLocator ()
 
 NullResourceLocator (NullResourceLocator const &src)
 
 ~NullResourceLocator () override
 
void show (std::ostream &out) const override
 Describe this instance to the given output stream; since there is no data in this class, merely print the name of this class. More...
 
std::string type () const override
 Return the name of this class: "NullResourceLocator". More...
 
ResourceStreamOP locate_resource_stream (std::string const &input_id) const override
 Create an empty NullResource object that will not be used. More...
 
void parse_my_tag (utility::tag::TagCOP tag) override
 Noop, since there is no data in this class. 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
 
VirtualBaseoperator= (VirtualBase const &)=default
 
VirtualBaseoperator= (VirtualBase &&)=default
 

Static Public Member Functions

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

Detailed Description

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.

Constructor & Destructor Documentation

basic::resource_manager::locator::NullResourceLocator::NullResourceLocator ( )
default
basic::resource_manager::locator::NullResourceLocator::NullResourceLocator ( NullResourceLocator const &  src)
default
basic::resource_manager::locator::NullResourceLocator::~NullResourceLocator ( )
overridedefault

Member Function Documentation

std::string basic::resource_manager::locator::NullResourceLocator::classname ( )
static
ResourceStreamOP basic::resource_manager::locator::NullResourceLocator::locate_resource_stream ( std::string const &  input_id) const
overridevirtual

Create an empty NullResource object that will not be used.

Implements basic::resource_manager::ResourceLocator.

void basic::resource_manager::locator::NullResourceLocator::parse_my_tag ( utility::tag::TagCOP  tag)
overridevirtual

Noop, since there is no data in this class.

Implements basic::resource_manager::ResourceLocator.

void basic::resource_manager::locator::NullResourceLocator::provide_xml_schema ( utility::tag::XMLSchemaDefinition xsd)
static
void basic::resource_manager::locator::NullResourceLocator::show ( std::ostream &  out) const
overridevirtual

Describe this instance to the given output stream; since there is no data in this class, merely print the name of this class.

Implements basic::resource_manager::ResourceLocator.

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

std::string basic::resource_manager::locator::NullResourceLocator::type ( ) const
overridevirtual

Return the name of this class: "NullResourceLocator".

Implements basic::resource_manager::ResourceLocator.

References classname().


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