basic::resource_manager::fallback_configuration::NativeFallbackConfiguration Class Reference

#include <NativeFallbackConfiguration.hh>

Public Types
typedef basic::resource_manager::ResourceDescription	ResourceDescription
Public Types inherited from utility::pointer::ReferenceCount
typedef platform::Size	Size
typedef platform::Size	size_type

Public Member Functions
	NativeFallbackConfiguration ()
virtual bool	fallback_specified (ResourceDescription const &desc) const
	Return true if a fallback been provided for the given resource description. It is possible that the fallback configuration would be unable to deliver a requested resource, e.g. if the appropriate command line option has not been provided. More...
virtual basic::resource_manager::LoaderType	get_resource_loader (ResourceDescription const &desc) const
	Return the name of the resource loader that should be used to instantiate the desired resource. More...
virtual basic::resource_manager::LocatorID	get_locator_id (ResourceDescription const &desc) const
	Return the locator id that the resource locator should use to find the data used to construct the desired resource - e.g. the file name. More...
virtual basic::resource_manager::ResourceOptionsOP	get_resource_options (ResourceDescription const &desc) const
	Return a pointer to the ResourceOptions object that the ResourceLoader will use to instantiate the given resource. Return 0 if the default ResourceOptions specified by the appropriate ResourceLoader should be used. More...
virtual std::string	could_not_create_resource_error_message (ResourceDescription const &desc) const
	If the FallbackConfiguration has not been provided the appropriate set of command line flags needed to construct the Resource given the resource description, then return an error message informing the user what options must be provided on the command line. More...
Public Member Functions inherited from basic::resource_manager::FallbackConfiguration
	FallbackConfiguration ()
	Default constructor for the FallbackConfiguration initializes nothing. More...
virtual	~FallbackConfiguration ()
	Destructor for the FallbackConfiguration does nothing. More...
Public Member Functions inherited from utility::pointer::ReferenceCount
void	ctor ()
virtual	~ReferenceCount ()
	Destructor. More...
Size	ref_count () const
	Reference count. More...

Private Member Functions
basic::resource_manager::LocatorID	get_native_filename_from_options () const

Additional Inherited Members
Protected Member Functions inherited from utility::pointer::ReferenceCount
	ReferenceCount ()
	Default constructor. More...
	ReferenceCount (ReferenceCount const &)
	Copy constructor. More...
ReferenceCount &	operator= (ReferenceCount const &)
	Copy assignment. More...

Member Typedef Documentation

typedef basic::resource_manager::ResourceDescription basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::ResourceDescription

Constructor & Destructor Documentation

basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::NativeFallbackConfiguration

(

)

Referenced by basic::resource_manager::fallback_configuration::NativeFallbackConfigurationCreator::create_fallback_configuration().

Member Function Documentation

std::string basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::could_not_create_resource_error_message ( ResourceDescription const &  desc ) const

virtual

If the FallbackConfiguration has not been provided the appropriate set of command line flags needed to construct the Resource given the resource description, then return an error message informing the user what options must be provided on the command line.

Implements basic::resource_manager::FallbackConfiguration.

bool basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::fallback_specified ( ResourceDescription const &  desc ) const

virtual

Return true if a fallback been provided for the given resource description. It is possible that the fallback configuration would be unable to deliver a requested resource, e.g. if the appropriate command line option has not been provided.

Implements basic::resource_manager::FallbackConfiguration.

References basic::options::OptionKeys::in::file::native, option, and options.

basic::resource_manager::LocatorID basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::get_locator_id ( ResourceDescription const &  desc ) const

virtual

Return the locator id that the resource locator should use to find the data used to construct the desired resource - e.g. the file name.

Implements basic::resource_manager::FallbackConfiguration.

References get_native_filename_from_options().

basic::resource_manager::LocatorID basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::get_native_filename_from_options ( ) const

private

References basic::options::OptionKeys::in::file::native, option, and options.

Referenced by get_locator_id().

basic::resource_manager::LoaderType basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::get_resource_loader ( ResourceDescription const &  desc ) const

virtual

Return the name of the resource loader that should be used to instantiate the desired resource.

Implements basic::resource_manager::FallbackConfiguration.

basic::resource_manager::ResourceOptionsOP basic::resource_manager::fallback_configuration::NativeFallbackConfiguration::get_resource_options ( ResourceDescription const &  desc ) const

virtual

Return a pointer to the ResourceOptions object that the ResourceLoader will use to instantiate the given resource. Return 0 if the default ResourceOptions specified by the appropriate ResourceLoader should be used.

Implements basic::resource_manager::FallbackConfiguration.

---

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

• src/basic/resource_manager/fallback_configuration/NativeFallbackConfiguration.hh
• src/basic/resource_manager/fallback_configuration/NativeFallbackConfiguration.cc