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

Class FallbackConfigurationFactory

                                                       object --+        
                                                                |        
                                                      ??.instance --+    
                                                                    |    
SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T --+
                                                                        |
                                                                       FallbackConfigurationFactory

The %FallbackConfigurationFactory is a singleton factory with which FallbackConfigurationCreator objects should be registered. The "fallback" system serves as a mechanism for preserving command-line functionality even while switching more protocols from requesting resources from the ResourceManager rather than reading directly from the command line. When a resource with a particular resource-description string is requested from the ResourceManager, and the ResourceManager does not have any instructions on how to load a resource matching that description, then the ResourceManager will then ask the FallbackConfigurationFactory for help. The FallbackConfigurationFactory can first answer "does this resource description match any resource descriptions for which you have a registered FallbackConfigurationCreator?" and if the answer is "yes", then the ResourceManager can request that FallbackConfigurationCreator and ask, first, if it is able to construct a resource (FallbackConfigurations often read from the command line, and it's possible that the required flags have not been put on the command line), and if so, then request data from the FallbackConfiguration needed to contruct that resource.

Instance Methods [hide private]
 
__init__(...)
Raises an exception This class cannot be instantiated from Python
 
create_fallback_configuration(...)
create_fallback_configuration( (FallbackConfigurationFactory)arg1, (str)resource_description) -> FallbackConfiguration : basic/resource_manager/FallbackConfigurationFactory.hh:68
 
factory_register(...)
factory_register( (FallbackConfigurationFactory)arg1, (__CPP_FallbackConfigurationCreator__)creator) -> None : basic/resource_manager/FallbackConfigurationFactory.hh:71
 
has_fallback_for_resource(...)
has_fallback_for_resource( (FallbackConfigurationFactory)arg1, (str)desc) -> bool : basic/resource_manager/FallbackConfigurationFactory.hh:74
 
set_throw_on_double_registration(...)
set_throw_on_double_registration( (FallbackConfigurationFactory)arg1) -> None : Only useful for unit testing.

Inherited from SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T: __reduce__

Inherited from unreachable.instance: __new__

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

Static Methods [hide private]

Inherited from SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T: get_instance

Class Variables [hide private]

Inherited from SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T: __instance_size__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

create_fallback_configuration(...)

 

create_fallback_configuration( (FallbackConfigurationFactory)arg1, (str)resource_description) -> FallbackConfiguration :
    basic/resource_manager/FallbackConfigurationFactory.hh:68

    C++ signature :
        boost::shared_ptr<basic::resource_manager::FallbackConfiguration> create_fallback_configuration(basic::resource_manager::FallbackConfigurationFactory {lvalue},std::string)

factory_register(...)

 

factory_register( (FallbackConfigurationFactory)arg1, (__CPP_FallbackConfigurationCreator__)creator) -> None :
    basic/resource_manager/FallbackConfigurationFactory.hh:71

    C++ signature :
        void factory_register(basic::resource_manager::FallbackConfigurationFactory {lvalue},boost::shared_ptr<basic::resource_manager::FallbackConfigurationCreator>)

has_fallback_for_resource(...)

 

has_fallback_for_resource( (FallbackConfigurationFactory)arg1, (str)desc) -> bool :
    basic/resource_manager/FallbackConfigurationFactory.hh:74

    C++ signature :
        bool has_fallback_for_resource(basic::resource_manager::FallbackConfigurationFactory {lvalue},std::string)

set_throw_on_double_registration(...)

 

set_throw_on_double_registration( (FallbackConfigurationFactory)arg1) -> None :
    Only useful for unit testing.  Since factory registration happens (sometimes) at
    load time, there may be no one to catch a thrown exception in the event of a name collision
    two FallbackConfigurationCreators that register for the same
    

    C++ signature :
        void set_throw_on_double_registration(basic::resource_manager::FallbackConfigurationFactory {lvalue})