Class ResourceLocator

 object --+    
          |    
??.instance --+
              |
             ResourceLocator

Known Subclasses:

%ResourceLocator classes are responsible for retrieving data from a data store that will be used to construct a Resource. This data store could be a file system or a database or any other place where data is stored. The ResourceManager asks the ResourceLocator to produce a ResourceStream object when given a "locator_id." A "locator_id" is what's needed to identify a data source from a data store: for example, for the FileSystemResourceLocator, the locator id is a file name; for the DatabaseResourceLocator, it would be a database query.

Instance Methods

[hide private]

__init__(...)
__init__( (object)arg1) -> None :

__reduce__(...)
helper for pickle

locate_resource_stream(...)
locate_resource_stream( (ResourceLocator)arg1, (str)locator_id) -> ResourceStream : Create and return a ResourceStream object from the given locator_id so that its stream can be passed to the ResourceLoader

locator_tag(...)
locator_tag( (ResourceLocator)arg1, (str)locator_tag) -> None : Set the name for this %ResourceLocator

parse_my_tag(...)
parse_my_tag( (ResourceLocator)arg1, (Tag)tag) -> None : Initialize the parameters for this %ResourceLocator from the contents of an XML file.

show(...)
show( (ResourceLocator)arg1, (OStream)out) -> None : Write a description of this %ResourceLocator to an out stream

type(...)
type( (ResourceLocator)arg1) -> str : Return the class name for this %ResourceLocator instance.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

__instance_size__ = 32

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)


__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

locate_resource_stream(...)


locate_resource_stream( (ResourceLocator)arg1, (str)locator_id) -> ResourceStream :
    Create and return a ResourceStream object from the given locator_id
    so that its stream can be passed to the ResourceLoader
    

    C++ signature :
        boost::shared_ptr<basic::resource_manager::ResourceStream> locate_resource_stream(basic::resource_manager::ResourceLocator {lvalue},std::string)

locate_resource_stream( (ResourceLocator)arg1, (str)arg2) -> None :

    C++ signature :
        void locate_resource_stream(boost::shared_ptr<ResourceLocator_exposer_callback> {lvalue},std::string)

locator_tag(...)


locator_tag( (ResourceLocator)arg1, (str)locator_tag) -> None :
    Set the name for this %ResourceLocator
    

    C++ signature :
        void locator_tag(basic::resource_manager::ResourceLocator {lvalue},std::string)

locator_tag( (ResourceLocator)arg1, (str)locator_tag) -> None :

    C++ signature :
        void locator_tag(ResourceLocator_exposer_callback {lvalue},std::string)

locator_tag( (ResourceLocator)arg1) -> str :
    Return the name for this %ResourceLocator
    

    C++ signature :
        std::string locator_tag(basic::resource_manager::ResourceLocator {lvalue})

locator_tag( (ResourceLocator)arg1) -> str :

    C++ signature :
        std::string locator_tag(ResourceLocator_exposer_callback {lvalue})

parse_my_tag(...)


parse_my_tag( (ResourceLocator)arg1, (Tag)tag) -> None :
    Initialize the parameters for this %ResourceLocator from the contents of
    an XML file.
    

    C++ signature :
        void parse_my_tag(basic::resource_manager::ResourceLocator {lvalue},boost::shared_ptr<utility::tag::Tag const>)

parse_my_tag( (ResourceLocator)arg1, (Tag)arg2) -> None :

    C++ signature :
        void parse_my_tag(boost::shared_ptr<ResourceLocator_exposer_callback> {lvalue},boost::shared_ptr<utility::tag::Tag const>)

show(...)


show( (ResourceLocator)arg1, (OStream)out) -> None :
    Write a description of this %ResourceLocator to an out stream
    

    C++ signature :
        void show(basic::resource_manager::ResourceLocator {lvalue},std::ostream {lvalue})

show( (ResourceLocator)arg1, (OStream)arg2) -> None :

    C++ signature :
        void show(boost::shared_ptr<ResourceLocator_exposer_callback> {lvalue},std::ostream {lvalue})

type(...)


type( (ResourceLocator)arg1) -> str :
    Return the class name for this %ResourceLocator instance.
    This function allows for better error message delivery.
    

    C++ signature :
        std::string type(basic::resource_manager::ResourceLocator {lvalue})

type( (ResourceLocator)arg1) -> None :

    C++ signature :
        void type(boost::shared_ptr<ResourceLocator_exposer_callback> {lvalue})

Class ResourceLocator

__init__(...) (Constructor)

__reduce__(...)

locate_resource_stream(...)

locator_tag(...)

parse_my_tag(...)

show(...)

type(...)

init(...)
(Constructor)

reduce(...)