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:

Public Member Functions
	NullResourceLocator ()
	NullResourceLocator (NullResourceLocator const &src)
virtual	~NullResourceLocator ()
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::pointer::ReferenceCount
	ReferenceCount ()
	Default constructor. More...
virtual	~ReferenceCount ()

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 ()

Additional Inherited Members
Public Types inherited from utility::pointer::ReferenceCount
typedef platform::Size	Size
typedef platform::Size	size_type

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 ( )

virtualdefault

Member Function Documentation

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

static

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

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

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::NullResourceLocatorCreator::provide_xml_schema().

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.

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:

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