Package rosetta :: Package basic :: Package resource_manager :: Module _basic_resource_manager_ :: Class LazyResourceManager
[hide private]
[frames] | no frames]

Class LazyResourceManager

                                          object --+            
                                                   |            
                                         ??.instance --+        
                                                       |        
SingletonBase_T_basic_resource_manager_ResourceManager_T --+    
                                                           |    
                                             ResourceManager --+
                                                               |
                                                              LazyResourceManager
Known Subclasses:

This is a mule class, meant to be derived from. It's job is to hold ResourceOptions and ResourceLocator objects by name (tag) as well as the ResourceConfigurations which serve as complete descriptions for how to construct a Resource. It should be thought of as a mule by classes that derive from it: it won't do anything on its own, but it can be directed to do things. The point of the class is to ake it easier to create ResourceManagers besides the JD2ResourceManager, which, at the time of this documentation, is the only class that derives from the LazyResourceManager.

Instance Methods [hide private]
 
__str__(...)
__str__( (LazyResourceManager)arg1) -> object :
 
add_job_options(...)
add_job_options( (LazyResourceManager)arg1, (str)job_tag, (__CPP_JobOptions__)job_options) -> None : basic/resource_manager/LazyResourceManager.hh:155
 
add_resource_configuration(...)
add_resource_configuration( (LazyResourceManager)arg1, (str)resource_tag, (ResourceConfiguration)resource_configuration) -> None : basic/resource_manager/LazyResourceManager.hh:173
 
add_resource_locator(...)
add_resource_locator( (LazyResourceManager)arg1, (str)locator_tag, (__CPP_ResourceLocator__)resource_locator) -> None : basic/resource_manager/LazyResourceManager.hh:179
 
add_resource_options(...)
add_resource_options( (LazyResourceManager)arg1, (str)resource_options_tag, (__CPP_ResourceOptions__)resource_options) -> None : basic/resource_manager/LazyResourceManager.hh:185
 
add_resource_tag_by_job_tag(...)
add_resource_tag_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag, (str)resource_tag) -> None : basic/resource_manager/LazyResourceManager.hh:95
 
clear(...)
clear( (LazyResourceManager)arg1) -> None : wipe out all data; useful for unit testing, but hard to fathom how it would be useful otherwise.
 
create_resource(...)
create_resource( (LazyResourceManager)arg1, (str)resource_tag) -> object : basic/resource_manager/LazyResourceManager.hh:218
 
create_resource_by_job_tag(...)
create_resource_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> object : basic/resource_manager/LazyResourceManager.hh:87
 
create_resources(...)
create_resources( (LazyResourceManager)arg1, (str)) -> None : Create all the resources for a particular job; this should be implemented by the derived class.
 
find_resource(...)
find_resource( (LazyResourceManager)arg1, (str)resource_tag) -> object : Get a resource with a given name.
 
find_resource_configuration(...)
find_resource_configuration( (LazyResourceManager)arg1, (str)resource_tag) -> ResourceConfiguration : basic/resource_manager/LazyResourceManager.hh:191
 
find_resource_locator(...)
find_resource_locator( (LazyResourceManager)arg1, (str)locator_tag) -> ResourceLocator : basic/resource_manager/LazyResourceManager.hh:196
 
find_resource_options(...)
find_resource_options( (LazyResourceManager)arg1, (str)resource_options_tag) -> ResourceOptions : basic/resource_manager/LazyResourceManager.hh:201
 
find_resource_tag_by_job_tag(...)
find_resource_tag_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> str : basic/resource_manager/LazyResourceManager.hh:107
 
free_resource_by_job_tag(...)
free_resource_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> None : basic/resource_manager/LazyResourceManager.hh:135
 
free_resource_by_tag(...)
free_resource_by_tag( (LazyResourceManager)arg1, (str)resource_tag) -> None : basic/resource_manager/LazyResourceManager.hh:141
 
get_count_of_jobs_associated_with_resource_tag(...)
get_count_of_jobs_associated_with_resource_tag( (LazyResourceManager)arg1, (str)resource_tag) -> int : basic/resource_manager/LazyResourceManager.hh:123
 
get_job_options(...)
get_job_options( (LazyResourceManager)arg1, (str)job_tag) -> JobOptions : basic/resource_manager/LazyResourceManager.hh:165
 
get_resource_by_job_tag(...)
get_resource_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> object : basic/resource_manager/LazyResourceManager.hh:113
 
get_resource_tags_for_job_tag(...)
get_resource_tags_for_job_tag( (LazyResourceManager)arg1, (str)job_tag) -> object : basic/resource_manager/LazyResourceManager.hh:118
 
has_job_options(...)
has_job_options( (LazyResourceManager)arg1, (str)job_tag) -> bool : basic/resource_manager/LazyResourceManager.hh:160
 
has_resource(...)
has_resource( (LazyResourceManager)arg1, (str)resource_tag) -> bool : Does a resource with a given name exist?
 
has_resource_configuration(...)
has_resource_configuration( (LazyResourceManager)arg1, (str)resource_tag) -> bool : has a ResourceConfiguration been provided to the LazyResourceManager for a Resource with a particular ResourceTag?
 
has_resource_locator(...)
has_resource_locator( (LazyResourceManager)arg1, (str)locator_tag) -> bool : has a ResourceLocator object been provided to the LazyResourceManager which has a particular LocatorTag?
 
has_resource_options(...)
has_resource_options( (LazyResourceManager)arg1, (str)resource_options_tag) -> bool : has a ResourceOptions object been provided to the LazyResourceManager which has a particular ResourceOptionsTag?
 
has_resource_tag_by_job_tag(...)
has_resource_tag_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> bool : basic/resource_manager/LazyResourceManager.hh:101
 
mark_job_tag_as_complete(...)
mark_job_tag_as_complete( (LazyResourceManager)arg1, (str)job_tag) -> None : remove the Job tag from incomplete_job_sets_ for each resource
 
show(...)
show( (LazyResourceManager)arg1, (OStream)out) -> None : basic/resource_manager/LazyResourceManager.hh:237

Inherited from ResourceManager: __init__, get_option, get_resource, has_option, has_resource_with_description

Inherited from SingletonBase_T_basic_resource_manager_ResourceManager_T: __reduce__

Inherited from unreachable.instance: __new__

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

Static Methods [hide private]

Inherited from SingletonBase_T_basic_resource_manager_ResourceManager_T: get_instance

Class Variables [hide private]

Inherited from SingletonBase_T_basic_resource_manager_ResourceManager_T: __instance_size__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__str__(...)
(Informal representation operator)

 

__str__( (LazyResourceManager)arg1) -> object :

    C++ signature :
        _object* __str__(basic::resource_manager::LazyResourceManager {lvalue})

Overrides: object.__str__

add_job_options(...)

 

add_job_options( (LazyResourceManager)arg1, (str)job_tag, (__CPP_JobOptions__)job_options) -> None :
    basic/resource_manager/LazyResourceManager.hh:155

    C++ signature :
        void add_job_options(basic::resource_manager::LazyResourceManager {lvalue},std::string,boost::shared_ptr<basic::resource_manager::JobOptions>)

add_resource_configuration(...)

 

add_resource_configuration( (LazyResourceManager)arg1, (str)resource_tag, (ResourceConfiguration)resource_configuration) -> None :
    basic/resource_manager/LazyResourceManager.hh:173

    C++ signature :
        void add_resource_configuration(basic::resource_manager::LazyResourceManager {lvalue},std::string,basic::resource_manager::ResourceConfiguration)

add_resource_locator(...)

 

add_resource_locator( (LazyResourceManager)arg1, (str)locator_tag, (__CPP_ResourceLocator__)resource_locator) -> None :
    basic/resource_manager/LazyResourceManager.hh:179

    C++ signature :
        void add_resource_locator(basic::resource_manager::LazyResourceManager {lvalue},std::string,boost::shared_ptr<basic::resource_manager::ResourceLocator>)

add_resource_options(...)

 

add_resource_options( (LazyResourceManager)arg1, (str)resource_options_tag, (__CPP_ResourceOptions__)resource_options) -> None :
    basic/resource_manager/LazyResourceManager.hh:185

    C++ signature :
        void add_resource_options(basic::resource_manager::LazyResourceManager {lvalue},std::string,boost::shared_ptr<basic::resource_manager::ResourceOptions>)

add_resource_tag_by_job_tag(...)

 

add_resource_tag_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag, (str)resource_tag) -> None :
    basic/resource_manager/LazyResourceManager.hh:95

    C++ signature :
        void add_resource_tag_by_job_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string,std::string,std::string)

clear(...)

 

clear( (LazyResourceManager)arg1) -> None :
    wipe out all data; useful for unit testing, but hard to fathom how it would be useful
    otherwise.
    

    C++ signature :
        void clear(basic::resource_manager::LazyResourceManager {lvalue})

Overrides: ResourceManager.clear

create_resource(...)

 

create_resource( (LazyResourceManager)arg1, (str)resource_tag) -> object :
    basic/resource_manager/LazyResourceManager.hh:218

    C++ signature :
        boost::shared_ptr<utility::pointer::ReferenceCount> create_resource(basic::resource_manager::LazyResourceManager {lvalue},std::string)

create_resource_by_job_tag(...)

 

create_resource_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> object :
    basic/resource_manager/LazyResourceManager.hh:87

    C++ signature :
        boost::shared_ptr<utility::pointer::ReferenceCount> create_resource_by_job_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string,std::string)

create_resources(...)

 

create_resources( (LazyResourceManager)arg1, (str)) -> None :
    Create all the resources for a particular job; this should be implemented by the derived
    class.  The implementation in this class calls utility::exit
    

    C++ signature :
        void create_resources(basic::resource_manager::LazyResourceManager {lvalue},std::string)

find_resource(...)

 

find_resource( (LazyResourceManager)arg1, (str)resource_tag) -> object :
    Get a resource with a given name.
    

    C++ signature :
        boost::shared_ptr<utility::pointer::ReferenceCount> find_resource(basic::resource_manager::LazyResourceManager {lvalue},std::string)

Overrides: ResourceManager.find_resource

find_resource_configuration(...)

 

find_resource_configuration( (LazyResourceManager)arg1, (str)resource_tag) -> ResourceConfiguration :
    basic/resource_manager/LazyResourceManager.hh:191

    C++ signature :
        basic::resource_manager::ResourceConfiguration find_resource_configuration(basic::resource_manager::LazyResourceManager {lvalue},std::string)

find_resource_locator(...)

 

find_resource_locator( (LazyResourceManager)arg1, (str)locator_tag) -> ResourceLocator :
    basic/resource_manager/LazyResourceManager.hh:196

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

find_resource_options(...)

 

find_resource_options( (LazyResourceManager)arg1, (str)resource_options_tag) -> ResourceOptions :
    basic/resource_manager/LazyResourceManager.hh:201

    C++ signature :
        boost::shared_ptr<basic::resource_manager::ResourceOptions> find_resource_options(basic::resource_manager::LazyResourceManager {lvalue},std::string)

find_resource_tag_by_job_tag(...)

 

find_resource_tag_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> str :
    basic/resource_manager/LazyResourceManager.hh:107

    C++ signature :
        std::string find_resource_tag_by_job_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string,std::string)

free_resource_by_job_tag(...)

 

free_resource_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> None :
    basic/resource_manager/LazyResourceManager.hh:135

    C++ signature :
        void free_resource_by_job_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string,std::string)

free_resource_by_tag(...)

 

free_resource_by_tag( (LazyResourceManager)arg1, (str)resource_tag) -> None :
    basic/resource_manager/LazyResourceManager.hh:141

    C++ signature :
        void free_resource_by_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string)

get_count_of_jobs_associated_with_resource_tag(...)

 

get_count_of_jobs_associated_with_resource_tag( (LazyResourceManager)arg1, (str)resource_tag) -> int :
    basic/resource_manager/LazyResourceManager.hh:123

    C++ signature :
        unsigned long get_count_of_jobs_associated_with_resource_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string)

get_job_options(...)

 

get_job_options( (LazyResourceManager)arg1, (str)job_tag) -> JobOptions :
    basic/resource_manager/LazyResourceManager.hh:165

    C++ signature :
        boost::shared_ptr<basic::resource_manager::JobOptions> get_job_options(basic::resource_manager::LazyResourceManager {lvalue},std::string)

get_resource_by_job_tag(...)

 

get_resource_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> object :
    basic/resource_manager/LazyResourceManager.hh:113

    C++ signature :
        boost::shared_ptr<utility::pointer::ReferenceCount> get_resource_by_job_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string,std::string)

get_resource_tags_for_job_tag(...)

 

get_resource_tags_for_job_tag( (LazyResourceManager)arg1, (str)job_tag) -> object :
    basic/resource_manager/LazyResourceManager.hh:118

    C++ signature :
        std::list<std::string, std::allocator<std::string> > get_resource_tags_for_job_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string)

has_job_options(...)

 

has_job_options( (LazyResourceManager)arg1, (str)job_tag) -> bool :
    basic/resource_manager/LazyResourceManager.hh:160

    C++ signature :
        bool has_job_options(basic::resource_manager::LazyResourceManager {lvalue},std::string)

has_resource(...)

 

has_resource( (LazyResourceManager)arg1, (str)resource_tag) -> bool :
    Does a resource with a given name exist?
    

    C++ signature :
        bool has_resource(basic::resource_manager::LazyResourceManager {lvalue},std::string)

Overrides: ResourceManager.has_resource

has_resource_configuration(...)

 

has_resource_configuration( (LazyResourceManager)arg1, (str)resource_tag) -> bool :
    has a ResourceConfiguration been provided to the LazyResourceManager for a Resource with a particular ResourceTag?
    

    C++ signature :
        bool has_resource_configuration(basic::resource_manager::LazyResourceManager {lvalue},std::string)

has_resource_locator(...)

 

has_resource_locator( (LazyResourceManager)arg1, (str)locator_tag) -> bool :
    has a ResourceLocator object been provided to the LazyResourceManager which has a particular LocatorTag?
    

    C++ signature :
        bool has_resource_locator(basic::resource_manager::LazyResourceManager {lvalue},std::string)

has_resource_options(...)

 

has_resource_options( (LazyResourceManager)arg1, (str)resource_options_tag) -> bool :
    has a ResourceOptions object been provided to the LazyResourceManager which has a particular ResourceOptionsTag?
    

    C++ signature :
        bool has_resource_options(basic::resource_manager::LazyResourceManager {lvalue},std::string)

has_resource_tag_by_job_tag(...)

 

has_resource_tag_by_job_tag( (LazyResourceManager)arg1, (str)resource_description, (str)job_tag) -> bool :
    basic/resource_manager/LazyResourceManager.hh:101

    C++ signature :
        bool has_resource_tag_by_job_tag(basic::resource_manager::LazyResourceManager {lvalue},std::string,std::string)

mark_job_tag_as_complete(...)

 

mark_job_tag_as_complete( (LazyResourceManager)arg1, (str)job_tag) -> None :
    remove the Job tag from incomplete_job_sets_ for each resource
    

    C++ signature :
        void mark_job_tag_as_complete(basic::resource_manager::LazyResourceManager {lvalue},std::string)

show(...)

 

show( (LazyResourceManager)arg1, (OStream)out) -> None :
    basic/resource_manager/LazyResourceManager.hh:237

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

Overrides: ResourceManager.show