Class FileSystemResourceLocator

                          object --+        
                                   |        
                         ??.instance --+    
                                       |    
_basic_resource_manager_.ResourceLocator --+
                                           |
                                          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.

Instance Methods

[hide private]

__init__(...)
__init__( (object)arg1, (object)open_mode) -> None : basic/resource_manager/locator/FileSystemResourceLocator.hh:87

get_open_mode(...)
get_open_mode( (FileSystemResourceLocator)arg1) -> object : basic/resource_manager/locator/FileSystemResourceLocator.hh:111

locate_resource_stream(...)
locate_resource_stream( (FileSystemResourceLocator)arg1, (str)locator_tag) -> ResourceStream : Construct a FileStream object given a file's name (its locator_tag)

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

parse_my_tag(...)
parse_my_tag( (FileSystemResourceLocator)arg1, (Tag)tag) -> None : Allows a default base_path to be specified for the locator.

set_open_mode(...)
set_open_mode( (FileSystemResourceLocator)arg1, (object)open_mode) -> None : basic/resource_manager/locator/FileSystemResourceLocator.hh:108

show(...)
show( (FileSystemResourceLocator)arg1, (OStream)out) -> None : basic/resource_manager/locator/FileSystemResourceLocator.hh:99

type(...)
type( (FileSystemResourceLocator)arg1) -> str : basic/resource_manager/locator/FileSystemResourceLocator.hh:103

Inherited from _basic_resource_manager_.ResourceLocator: __reduce__

Inherited from unreachable.instance: __new__

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

Class Variables

[hide private]

Inherited from _basic_resource_manager_.ResourceLocator: __instance_size__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)


__init__( (object)arg1, (object)open_mode) -> None :
    basic/resource_manager/locator/FileSystemResourceLocator.hh:87

    C++ signature :
        void __init__(_object*,std::_Ios_Openmode)

__init__( (object)arg1, (FileSystemResourceLocator)src) -> None :
    basic/resource_manager/locator/FileSystemResourceLocator.hh:91

    C++ signature :
        void __init__(_object*,basic::resource_manager::locator::FileSystemResourceLocator)

Overrides: object.__init__

get_open_mode(...)


get_open_mode( (FileSystemResourceLocator)arg1) -> object :
    basic/resource_manager/locator/FileSystemResourceLocator.hh:111

    C++ signature :
        std::_Ios_Openmode get_open_mode(basic::resource_manager::locator::FileSystemResourceLocator {lvalue})

locate_resource_stream(...)


locate_resource_stream( (FileSystemResourceLocator)arg1, (str)locator_tag) -> ResourceStream :
    Construct a FileStream object given a file's name (its locator_tag)
    

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

locate_resource_stream( (FileSystemResourceLocator)arg1, (str)locator_tag) -> ResourceStream :

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

Overrides: _basic_resource_manager_.ResourceLocator.locate_resource_stream

locator_tag(...)


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

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

locator_tag( (FileSystemResourceLocator)arg1) -> str :

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

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

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

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

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

Overrides: _basic_resource_manager_.ResourceLocator.locator_tag

parse_my_tag(...)


parse_my_tag( (FileSystemResourceLocator)arg1, (Tag)tag) -> None :
    Allows a default base_path to be specified for the locator.
    

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

parse_my_tag( (FileSystemResourceLocator)arg1, (Tag)tag) -> None :

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

Overrides: _basic_resource_manager_.ResourceLocator.parse_my_tag

set_open_mode(...)


set_open_mode( (FileSystemResourceLocator)arg1, (object)open_mode) -> None :
    basic/resource_manager/locator/FileSystemResourceLocator.hh:108

    C++ signature :
        void set_open_mode(basic::resource_manager::locator::FileSystemResourceLocator {lvalue},std::_Ios_Openmode)

show(...)


show( (FileSystemResourceLocator)arg1, (OStream)out) -> None :
    basic/resource_manager/locator/FileSystemResourceLocator.hh:99

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

show( (FileSystemResourceLocator)arg1, (OStream)out) -> None :

    C++ signature :
        void show(FileSystemResourceLocator_exposer_callback {lvalue},std::ostream {lvalue})

Overrides: _basic_resource_manager_.ResourceLocator.show

type(...)


type( (FileSystemResourceLocator)arg1) -> str :
    basic/resource_manager/locator/FileSystemResourceLocator.hh:103

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

type( (FileSystemResourceLocator)arg1) -> str :

    C++ signature :
        std::string type(FileSystemResourceLocator_exposer_callback {lvalue})

Overrides: _basic_resource_manager_.ResourceLocator.type

Class FileSystemResourceLocator

__init__(...) (Constructor)

get_open_mode(...)

locate_resource_stream(...)

locator_tag(...)

parse_my_tag(...)

set_open_mode(...)

show(...)

type(...)

init(...)
(Constructor)