rosetta.basic.resource_manager._basic_resource_manager_ module
Classes
class FallbackConfiguration
The %FallbackConfiguration class describes how a resource should be created if the ResourceManager is not being used, i.e., if resources have been specified through flags on the command line instead of through a resource-definition file. A protocol will still query the ResourceManager for its desired resource in such a case (by its "resource_description") and if no resource has been provided for that description, then the ResourceManager will ask the FallbackConfigurationFactory for the %FallbackConfiguration that has been registered for that resource description (this registration logic is handled by the FallbackConfigurationCreator) and ask it to provide the information necessary to create the appropriate resource from the command line. For example, a user can define the loop they are interested in modeling to the loop-modeling protocol via the LoopsFileData resource. The loop modeling protocol once was but is no longer responsible for opening a text file and creating a LoopsFileData object from that text file; instead it asks the ResourceManager directly for the resource. For the sake of backwards compatibility, the ResourceManager must have some way of creating a LoopsFileData object from the command line. If someone is using the loop modeling application, but does not provide a resource definition, then the LoopsFileFallbackConfiguration (derived from %FallbackConfiguration) will be called upon by the ResourceManager for three things: 1) the name of the ResourceLoader to use to create the resource ("LoopsFile"), 2) the locator_id for the Resource (which it goes to the command line to find), and 3) a ResourceOptionsOP which is either null (meaning "use the default") or is in some way initialized with options from the command line. With these three bits, the ResourceManager will go the appropriate ResourceLoader and request the construction of the Resource as usual, opening the file using the default ResourceLocator (for the JD2ResourceManager, this is the FileSystemResourceLocator).
Ancestors (in MRO)
- FallbackConfiguration
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def could_not_create_resource_error_message(
...)
could_not_create_resource_error_message( (FallbackConfiguration)arg1, (str)desc) -> str : 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.
C++ signature :
std::string could_not_create_resource_error_message(basic::resource_manager::FallbackConfiguration {lvalue},std::string)
could_not_create_resource_error_message( (FallbackConfiguration)arg1, (str)arg2) -> None :
C++ signature :
void could_not_create_resource_error_message(boost::shared_ptr<FallbackConfiguration_exposer_callback> {lvalue},std::string)
def fallback_specified(
...)
fallback_specified( (FallbackConfiguration)arg1, (str)desc) -> bool : 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.
C++ signature :
bool fallback_specified(basic::resource_manager::FallbackConfiguration {lvalue},std::string)
fallback_specified( (FallbackConfiguration)arg1, (str)arg2) -> None :
C++ signature :
void fallback_specified(boost::shared_ptr<FallbackConfiguration_exposer_callback> {lvalue},std::string)
def get_locator_id(
...)
get_locator_id( (FallbackConfiguration)arg1, (str)desc) -> str : 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.
C++ signature :
std::string get_locator_id(basic::resource_manager::FallbackConfiguration {lvalue},std::string)
get_locator_id( (FallbackConfiguration)arg1, (str)arg2) -> None :
C++ signature :
void get_locator_id(boost::shared_ptr<FallbackConfiguration_exposer_callback> {lvalue},std::string)
def get_resource_loader(
...)
get_resource_loader( (FallbackConfiguration)arg1, (str)desc) -> str : Return the name of the resource loader that should be used to instantiate the desired resource
C++ signature :
std::string get_resource_loader(basic::resource_manager::FallbackConfiguration {lvalue},std::string)
get_resource_loader( (FallbackConfiguration)arg1, (str)arg2) -> None :
C++ signature :
void get_resource_loader(boost::shared_ptr<FallbackConfiguration_exposer_callback> {lvalue},std::string)
def get_resource_options(
...)
get_resource_options( (FallbackConfiguration)arg1, (str)desc) -> ResourceOptions : 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.
C++ signature :
boost::shared_ptr<basic::resource_manager::ResourceOptions> get_resource_options(basic::resource_manager::FallbackConfiguration {lvalue},std::string)
get_resource_options( (FallbackConfiguration)arg1, (str)arg2) -> None :
C++ signature :
void get_resource_options(boost::shared_ptr<FallbackConfiguration_exposer_callback> {lvalue},std::string)
class FallbackConfigurationAP
Ancestors (in MRO)
- FallbackConfigurationAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (FallbackConfigurationAP)arg1) -> FallbackConfiguration :
C++ signature :
boost::shared_ptr
class FallbackConfigurationCAP
Ancestors (in MRO)
- FallbackConfigurationCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (FallbackConfigurationCAP)arg1) -> FallbackConfiguration :
C++ signature :
boost::shared_ptr
class FallbackConfigurationCreator
The %FallbackConfigurationCreator plays the role in the ResourceManager framework of gluing a "resource_description" string and a FallbackConfiguration together. The ResourceManager looks to a FallbackConfiguration when a resource is requested by a resource description string but no resource definition file has been provided. In such a case, the FallbackConfiguration will provide the information the ResourceManager needs to create the resource. It's the %FallbackConfigurationCreator's job to inform the ResourceManager which FallbackConfiguration to talk to. Each class derived from the %FallbackConfigurationCreator will instantiate a single FallbackConfiguration and act to pair a string, a "resource description," with that FallbackConfiguration. For example "LoopFile" as a resource description will be paired by the LoopFileFallbackConfigurationCreator with the LoopFileFallbackConfiguration. Multiple resource descriptions can be paired with a single FallbackConfiguration.
Ancestors (in MRO)
- FallbackConfigurationCreator
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def create_fallback_configuration(
...)
create_fallback_configuration( (FallbackConfigurationCreator)arg1) -> FallbackConfiguration : basic/resource_manager/FallbackConfigurationCreator.hh:57
C++ signature :
boost::shared_ptr<basic::resource_manager::FallbackConfiguration> create_fallback_configuration(basic::resource_manager::FallbackConfigurationCreator {lvalue})
create_fallback_configuration( (FallbackConfigurationCreator)arg1) -> None :
C++ signature :
void create_fallback_configuration(boost::shared_ptr<FallbackConfigurationCreator_exposer_callback> {lvalue})
def resource_description(
...)
resource_description( (FallbackConfigurationCreator)arg1) -> str : basic/resource_manager/FallbackConfigurationCreator.hh:60
C++ signature :
std::string resource_description(basic::resource_manager::FallbackConfigurationCreator {lvalue})
resource_description( (FallbackConfigurationCreator)arg1) -> None :
C++ signature :
void resource_description(boost::shared_ptr<FallbackConfigurationCreator_exposer_callback> {lvalue})
class FallbackConfigurationCreatorAP
Ancestors (in MRO)
- FallbackConfigurationCreatorAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (FallbackConfigurationCreatorAP)arg1) -> FallbackConfigurationCreator :
C++ signature :
boost::shared_ptr
class FallbackConfigurationCreatorCAP
Ancestors (in MRO)
- FallbackConfigurationCreatorCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (FallbackConfigurationCreatorCAP)arg1) -> FallbackConfigurationCreator :
C++ signature :
boost::shared_ptr
class 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.
Ancestors (in MRO)
- FallbackConfigurationFactory
- SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def create_fallback_configuration(
...)
create_fallback_configuration( (FallbackConfigurationFactory)arg1, (str)resource_description) -> FallbackConfiguration : basic/resource_manager/FallbackConfigurationFactory.hh:68
C++ signature :
boost::shared_ptr
def 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
def 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)
def 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})
class FallbackConfigurationFactoryAP
Ancestors (in MRO)
- FallbackConfigurationFactoryAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (FallbackConfigurationFactoryAP)arg1) -> FallbackConfigurationFactory :
C++ signature :
boost::shared_ptr
class FallbackConfigurationFactoryCAP
Ancestors (in MRO)
- FallbackConfigurationFactoryCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (FallbackConfigurationFactoryCAP)arg1) -> FallbackConfigurationFactory :
C++ signature :
boost::shared_ptr
class JobOptions
The %JobOptions class holds job-specific options (i.e. command line flags). It can be used by the ResourceManager to hold options for a particular job, so that the ResourceManager can retrieve those options as needed. It is basically a bag for 12 OptionKey/OptionKeyValue maps, one for every kind of OptionKey.
Ancestors (in MRO)
- JobOptions
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def add_option(
...)
add_option( (JobOptions)arg1, (object)key, (bool)val) -> None : Set the value for the indicated boolean option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::BooleanOptionKey,bool)
add_option( (JobOptions)arg1, (object)key, (vector1_bool)val) -> None : Set the value for the indicated boolean-vector option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::BooleanVectorOptionKey,utility::vector1<bool, std::allocator<bool> >)
add_option( (JobOptions)arg1, (object)key, (FileName)val) -> None : Set the value for the indicated file option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::FileOptionKey,utility::file::FileName)
add_option( (JobOptions)arg1, (object)key, (object)val) -> None : Set the value for the indicated file-vector option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::FileVectorOptionKey,utility::vector1<utility::file::FileName, std::allocator<utility::file::FileName> >)
add_option( (JobOptions)arg1, (object)key, (int)val) -> None : Set the value for the indicated integer option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::IntegerOptionKey,int)
add_option( (JobOptions)arg1, (object)key, (vector1_int)val) -> None : Set the value for the indicated integer-vector option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::IntegerVectorOptionKey,utility::vector1<int, std::allocator<int> >)
add_option( (JobOptions)arg1, (object)key, (PathName)val) -> None : Set the value for the indicated path option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::PathOptionKey,utility::file::PathName)
add_option( (JobOptions)arg1, (object)key, (object)val) -> None : Set the value for the indicated path-vector option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::PathVectorOptionKey,utility::vector1<utility::file::PathName, std::allocator<utility::file::PathName> >)
add_option( (JobOptions)arg1, (object)key, (float)val) -> None : Set the value for the indicated real option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::RealOptionKey,double)
add_option( (JobOptions)arg1, (object)key, (vector1_Real)val) -> None : Set the value for the indicated real-vector option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::RealVectorOptionKey,utility::vector1<double, std::allocator<double> >)
add_option( (JobOptions)arg1, (object)key, (str)val) -> None : Set the value for the indicated string option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::StringOptionKey,std::string)
add_option( (JobOptions)arg1, (object)key, (vector1_string)val) -> None : Set the value for the indicated string-vector option
C++ signature :
void add_option(basic::resource_manager::JobOptions {lvalue},utility::options::StringVectorOptionKey,utility::vector1<std::string, std::allocator<std::string> >)
def get_option(
...)
get_option( (JobOptions)arg1, (object)key) -> bool : Return the value of the indicated boolean option
C++ signature :
bool get_option(basic::resource_manager::JobOptions {lvalue},utility::options::BooleanOptionKey)
get_option( (JobOptions)arg1, (object)key) -> vector1_bool : Return the value of the indicated boolean-vector option
C++ signature :
utility::vector1<bool, std::allocator<bool> > get_option(basic::resource_manager::JobOptions {lvalue},utility::options::BooleanVectorOptionKey)
get_option( (JobOptions)arg1, (object)key) -> FileName : Return the value of the indicated file option
C++ signature :
utility::file::FileName get_option(basic::resource_manager::JobOptions {lvalue},utility::options::FileOptionKey)
get_option( (JobOptions)arg1, (object)key) -> object : Return the value of the indicated file-vector option
C++ signature :
utility::vector1<utility::file::FileName, std::allocator<utility::file::FileName> > get_option(basic::resource_manager::JobOptions {lvalue},utility::options::FileVectorOptionKey)
get_option( (JobOptions)arg1, (object)key) -> int : Return the value of the indicated integer option
C++ signature :
int get_option(basic::resource_manager::JobOptions {lvalue},utility::options::IntegerOptionKey)
get_option( (JobOptions)arg1, (object)key) -> vector1_int : Return the value of the indicated integer-vector option
C++ signature :
utility::vector1<int, std::allocator<int> > get_option(basic::resource_manager::JobOptions {lvalue},utility::options::IntegerVectorOptionKey)
get_option( (JobOptions)arg1, (object)key) -> PathName : Return the value of the indicated path option
C++ signature :
utility::file::PathName get_option(basic::resource_manager::JobOptions {lvalue},utility::options::PathOptionKey)
get_option( (JobOptions)arg1, (object)key) -> object : Return the value of the indicated path-vector option
C++ signature :
utility::vector1<utility::file::PathName, std::allocator<utility::file::PathName> > get_option(basic::resource_manager::JobOptions {lvalue},utility::options::PathVectorOptionKey)
get_option( (JobOptions)arg1, (object)key) -> float : Return the value of the indicated real option
C++ signature :
double get_option(basic::resource_manager::JobOptions {lvalue},utility::options::RealOptionKey)
get_option( (JobOptions)arg1, (object)key) -> vector1_Real : Return the value of the indicated real-vector option
C++ signature :
utility::vector1<double, std::allocator<double> > get_option(basic::resource_manager::JobOptions {lvalue},utility::options::RealVectorOptionKey)
get_option( (JobOptions)arg1, (object)key) -> str : Return the value of the indicated string option
C++ signature :
std::string get_option(basic::resource_manager::JobOptions {lvalue},utility::options::StringOptionKey)
get_option( (JobOptions)arg1, (object)key) -> vector1_string : Return the value of the indicated string-vector option
C++ signature :
utility::vector1<std::string, std::allocator<std::string> > get_option(basic::resource_manager::JobOptions {lvalue},utility::options::StringVectorOptionKey)
def has_option(
...)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated boolean option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::BooleanOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated boolean-vector option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::BooleanVectorOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated file option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::FileOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated file-vector option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::FileVectorOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated integer option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::IntegerOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated integer-vector option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::IntegerVectorOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated path option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::PathOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated path-vector option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::PathVectorOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated real option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::RealOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated real-vector option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::RealVectorOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated string option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::StringOptionKey)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated string-vector option has been set
C++ signature :
bool has_option(basic::resource_manager::JobOptions {lvalue},utility::options::StringVectorOptionKey)
def show(
...)
show( (JobOptions)arg1, (OStream)out) -> None : Describe this %JobOptions to the given output stream
C++ signature :
void show(basic::resource_manager::JobOptions {lvalue},std::ostream {lvalue})
show( (JobOptions)arg1, (OStream)out) -> None :
C++ signature :
void show(JobOptions_exposer_callback {lvalue},std::ostream {lvalue})
class JobOptionsAP
Ancestors (in MRO)
- JobOptionsAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (JobOptionsAP)arg1) -> JobOptions :
C++ signature :
boost::shared_ptr
class JobOptionsCAP
Ancestors (in MRO)
- JobOptionsCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (JobOptionsCAP)arg1) -> JobOptions :
C++ signature :
boost::shared_ptr
class LazyResourceManager
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.
Ancestors (in MRO)
- LazyResourceManager
- ResourceManager
- SingletonBase_T_basic_resource_manager_ResourceManager_T
- Boost.Python.instance
- __builtin__.object
Methods
def 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
def 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)
def 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
def 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
def 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)
def clear(
...)
Inheritance:
ResourceManager.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})
def create_resource(
...)
create_resource( (LazyResourceManager)arg1, (str)resource_tag) -> object : basic/resource_manager/LazyResourceManager.hh:218
C++ signature :
boost::shared_ptr
def 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
def 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)
def find_resource(
...)
Inheritance:
ResourceManager.find_resource
find_resource( (LazyResourceManager)arg1, (str)resource_tag) -> object : Get a resource with a given name.
C++ signature :
boost::shared_ptr
def 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)
def find_resource_locator(
...)
find_resource_locator( (LazyResourceManager)arg1, (str)locator_tag) -> ResourceLocator : basic/resource_manager/LazyResourceManager.hh:196
C++ signature :
boost::shared_ptr
def find_resource_options(
...)
find_resource_options( (LazyResourceManager)arg1, (str)resource_options_tag) -> ResourceOptions : basic/resource_manager/LazyResourceManager.hh:201
C++ signature :
boost::shared_ptr
def 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)
def 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)
def 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)
def 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)
def get_job_options(
...)
get_job_options( (LazyResourceManager)arg1, (str)job_tag) -> JobOptions : basic/resource_manager/LazyResourceManager.hh:165
C++ signature :
boost::shared_ptr
def get_option(
...)
Inheritance:
ResourceManager.get_option
get_option( (ResourceManager)arg1, (object)key) -> bool : The following 12 functions allow protocols to request options that may have been set for the context in which the protocol is being run. Retrieve the boolean value represented by the given option key
C++ signature :
bool get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_bool : Retrieve the vector of boolean values represented by the given option key
C++ signature :
utility::vector1<bool, std::allocator<bool> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> FileName : Retrieve the FileName value represented by the given option key
C++ signature :
utility::file::FileName get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> object : Retrieve the vector of FileName values represented by the given option key
C++ signature :
utility::vector1<utility::file::FileName, std::allocator<utility::file::FileName> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> int : Retrieve the integer value represented by the given option key
C++ signature :
int get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_int : Retrieve the vector of integer values represented by the given option key
C++ signature :
utility::vector1<int, std::allocator<int> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> PathName : Retrieve the PathName value represented by the given option key
C++ signature :
utility::file::PathName get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> object : Retrieve the vector of PathName values represented by the given option key
C++ signature :
utility::vector1<utility::file::PathName, std::allocator<utility::file::PathName> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> float : Retrieve the Real value represented by the given option key
C++ signature :
double get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_Real : Retrieve the vector of Real values represented by the given option key
C++ signature :
utility::vector1<double, std::allocator<double> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> str : Retrieve the string value represented by the given option key
C++ signature :
std::string get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_string : Retrieve the vector of string values represented by the given option key
C++ signature :
utility::vector1<std::string, std::allocator<std::string> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringVectorOptionKey)
def get_resource(
...)
Inheritance:
ResourceManager.get_resource
get_resource( (ResourceManager)arg1, (str)resource_description) -> object : Returns the resource with the given resource_description.
C++ signature :
boost::shared_ptr<utility::pointer::ReferenceCount> get_resource(basic::resource_manager::ResourceManager {lvalue},std::string)
get_resource( (ResourceManager)arg1, (str)arg2) -> None :
C++ signature :
void get_resource(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},std::string)
def 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
def 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
def 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)
def has_option(
...)
Inheritance:
ResourceManager.has_option
has_option( (ResourceManager)arg1, (object)key) -> bool : The following 12 functions allow protocols to request if a particular option has been set (e.g. on the command line or for the current job). Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringVectorOptionKey)
def has_resource(
...)
Inheritance:
ResourceManager.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)
def 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)
def 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)
def 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)
def 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)
def has_resource_with_description(
...)
Inheritance:
ResourceManager.has_resource_with_description
has_resource_with_description( (ResourceManager)arg1, (str)resource_description) -> bool : A protocol may ask whether a resource with a given resource description has been provided. It is possible that some resources are available sometimes when running a protocol, but not always (e.g. when running abinitio, sometimes you don't know what the native structure is).
C++ signature :
bool has_resource_with_description(basic::resource_manager::ResourceManager {lvalue},std::string)
has_resource_with_description( (ResourceManager)arg1, (str)arg2) -> None :
C++ signature :
void has_resource_with_description(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},std::string)
def 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)
def show(
...)
Inheritance:
ResourceManager.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})
class LazyResourceManagerAP
Ancestors (in MRO)
- LazyResourceManagerAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (LazyResourceManagerAP)arg1) -> LazyResourceManager :
C++ signature :
boost::shared_ptr
class LazyResourceManagerCAP
Ancestors (in MRO)
- LazyResourceManagerCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (LazyResourceManagerCAP)arg1) -> LazyResourceManager :
C++ signature :
boost::shared_ptr
class ResourceConfiguration
The set of strings necessary to describe how a resource should be constructed.
Ancestors (in MRO)
- ResourceConfiguration
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def show(
...)
show( (ResourceConfiguration)arg1, (OStream)out) -> None : basic/resource_manager/LazyResourceManager.hh:52
C++ signature :
void show(basic::resource_manager::ResourceConfiguration {lvalue},std::ostream {lvalue})
show( (ResourceConfiguration)arg1, (OStream)out) -> None :
C++ signature :
void show(ResourceConfiguration_exposer_callback {lvalue},std::ostream {lvalue})
class ResourceConfigurationAP
Ancestors (in MRO)
- ResourceConfigurationAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceConfigurationAP)arg1) -> ResourceConfiguration :
C++ signature :
boost::shared_ptr
class ResourceConfigurationCAP
Ancestors (in MRO)
- ResourceConfigurationCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceConfigurationCAP)arg1) -> ResourceConfiguration :
C++ signature :
boost::shared_ptr
class ResourceLoader
The ResourceLoader is responsible for instantiating a Resource object and initializing it. In order to do so, the ResourceLoader is given an input stream and a ResourceOptions object. Note that the ResourceOptions object has to be of the right type, or the ResourceLoader will not be able to read the data that it needs out of it. If the ResourceLoader is given the wrong kind of ResourceOptions object, it will throw an exception.
Ancestors (in MRO)
- ResourceLoader
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def create_resource(
...)
create_resource( (ResourceLoader)arg1, (ResourceOptions)options, (str)locator_id, (std_istream)istream) -> object : Create a resource, held in an owning pointer, of any type which will be stored and whose lifetime will be governed by the ResourceManager
C++ signature :
boost::shared_ptr<utility::pointer::ReferenceCount> create_resource(basic::resource_manager::ResourceLoader {lvalue},basic::resource_manager::ResourceOptions,std::string,std::istream {lvalue})
create_resource( (ResourceLoader)arg1, (ResourceOptions)arg2, (str)arg3, (std_istream)arg4) -> None :
C++ signature :
void create_resource(boost::shared_ptr<ResourceLoader_exposer_callback> {lvalue},basic::resource_manager::ResourceOptions,std::string,std::istream {lvalue})
def default_options(
...)
default_options( (ResourceLoader)arg1) -> ResourceOptions : basic/resource_manager/ResourceLoader.hh:57
C++ signature :
boost::shared_ptr<basic::resource_manager::ResourceOptions> default_options(basic::resource_manager::ResourceLoader {lvalue})
default_options( (ResourceLoader)arg1) -> None :
C++ signature :
void default_options(boost::shared_ptr<ResourceLoader_exposer_callback> {lvalue})
class ResourceLoaderAP
Ancestors (in MRO)
- ResourceLoaderAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLoaderAP)arg1) -> ResourceLoader :
C++ signature :
boost::shared_ptr
class ResourceLoaderCAP
Ancestors (in MRO)
- ResourceLoaderCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLoaderCAP)arg1) -> ResourceLoader :
C++ signature :
boost::shared_ptr
class ResourceLoaderCreator
Instantiates a ResourceLoader as part of the ResourceLoaderFactory scheme. Derived classes should be registered with the ResourceLoaderFactory in one of the library init.cc files with a ResourceLoaderRegistrator
Ancestors (in MRO)
- ResourceLoaderCreator
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def create_resource_loader(
...)
create_resource_loader( (ResourceLoaderCreator)arg1) -> ResourceLoader : Instantiate a ResourceLoader
C++ signature :
boost::shared_ptr<basic::resource_manager::ResourceLoader> create_resource_loader(basic::resource_manager::ResourceLoaderCreator {lvalue})
create_resource_loader( (ResourceLoaderCreator)arg1) -> None :
C++ signature :
void create_resource_loader(boost::shared_ptr<ResourceLoaderCreator_exposer_callback> {lvalue})
def loader_type(
...)
loader_type( (ResourceLoaderCreator)arg1) -> str : Give the name of the ResourceLoader that this Creator will instantiate.
C++ signature :
std::string loader_type(basic::resource_manager::ResourceLoaderCreator {lvalue})
loader_type( (ResourceLoaderCreator)arg1) -> None :
C++ signature :
void loader_type(boost::shared_ptr<ResourceLoaderCreator_exposer_callback> {lvalue})
class ResourceLoaderCreatorAP
Ancestors (in MRO)
- ResourceLoaderCreatorAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLoaderCreatorAP)arg1) -> ResourceLoaderCreator :
C++ signature :
boost::shared_ptr
class ResourceLoaderCreatorCAP
Ancestors (in MRO)
- ResourceLoaderCreatorCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLoaderCreatorCAP)arg1) -> ResourceLoaderCreator :
C++ signature :
boost::shared_ptr
class ResourceLoaderFactory
Instantiates ResourceLoaders. Creators may be registered with the Factory at any point, though it is recommended they be registered at load time. If two Creators are registered and they both give the same name for the ResourceLoader they say they will instantiate, then the Factory will exit with an error message.
Ancestors (in MRO)
- ResourceLoaderFactory
- SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def available_resource_loaders(
...)
available_resource_loaders( (ResourceLoaderFactory)arg1) -> object : Return a list of all the resource loaders available
C++ signature :
std::list
def create_resource_loader(
...)
create_resource_loader( (ResourceLoaderFactory)arg1, (str)loader_type) -> ResourceLoader : Instantiates a resource loader ofa given type; throws an exception if no loader with this type has been previously registered.
C++ signature :
boost::shared_ptr
def factory_register(
...)
factory_register( (ResourceLoaderFactory)arg1, (CPP_ResourceLoaderCreator)creator) -> None : Register a ResourceLoaderCreator with the factory. The factory asks the Creator for the name of the ResourceLoader that it will create; if another Creator has already registered with the factory that proports to instantiate another ResourceLoader with the same name, then it will exit with an error message, or, if set_throw_on_double_registration() has previously been called, throw an exception.
C++ signature :
void factory_register(basic::resource_manager::ResourceLoaderFactory {lvalue},boost::shared_ptr
def has_resource_loader(
...)
has_resource_loader( (ResourceLoaderFactory)arg1, (str)loader_type) -> bool : Returns true if a resource loader of the given type has been registered with the factory
C++ signature : bool has_resource_loader(basic::resource_manager::ResourceLoaderFactory {lvalue},std::string)
def set_throw_on_double_registration(
...)
set_throw_on_double_registration( (ResourceLoaderFactory)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::ResourceLoaderFactory {lvalue})
class ResourceLoaderFactoryAP
Ancestors (in MRO)
- ResourceLoaderFactoryAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLoaderFactoryAP)arg1) -> ResourceLoaderFactory :
C++ signature :
boost::shared_ptr
class ResourceLoaderFactoryCAP
Ancestors (in MRO)
- ResourceLoaderFactoryCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLoaderFactoryCAP)arg1) -> ResourceLoaderFactory :
C++ signature :
boost::shared_ptr
class ResourceLocator
%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.
Ancestors (in MRO)
- ResourceLocator
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def 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)
def 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})
def 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>)
def 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})
def 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 ResourceLocatorAP
Ancestors (in MRO)
- ResourceLocatorAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLocatorAP)arg1) -> ResourceLocator :
C++ signature :
boost::shared_ptr
class ResourceLocatorCAP
Ancestors (in MRO)
- ResourceLocatorCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLocatorCAP)arg1) -> ResourceLocator :
C++ signature :
boost::shared_ptr
class ResourceLocatorCreator
The %ResourceLocatorCreator class serves to link the name of a locator type and the (derived) ResourceLocator class that's responsible for retrieving data from a data store.
Ancestors (in MRO)
- ResourceLocatorCreator
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def create_resource_locator(
...)
create_resource_locator( (ResourceLocatorCreator)arg1) -> ResourceLocator : basic/resource_manager/ResourceLocatorCreator.hh:45
C++ signature :
boost::shared_ptr<basic::resource_manager::ResourceLocator> create_resource_locator(basic::resource_manager::ResourceLocatorCreator {lvalue})
create_resource_locator( (ResourceLocatorCreator)arg1) -> None :
C++ signature :
void create_resource_locator(boost::shared_ptr<ResourceLocatorCreator_exposer_callback> {lvalue})
def locator_type(
...)
locator_type( (ResourceLocatorCreator)arg1) -> str : basic/resource_manager/ResourceLocatorCreator.hh:48
C++ signature :
std::string locator_type(basic::resource_manager::ResourceLocatorCreator {lvalue})
locator_type( (ResourceLocatorCreator)arg1) -> None :
C++ signature :
void locator_type(boost::shared_ptr<ResourceLocatorCreator_exposer_callback> {lvalue})
class ResourceLocatorCreatorAP
Ancestors (in MRO)
- ResourceLocatorCreatorAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLocatorCreatorAP)arg1) -> ResourceLocatorCreator :
C++ signature :
boost::shared_ptr
class ResourceLocatorCreatorCAP
Ancestors (in MRO)
- ResourceLocatorCreatorCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLocatorCreatorCAP)arg1) -> ResourceLocatorCreator :
C++ signature :
boost::shared_ptr
class ResourceLocatorFactory
The %ResourceLocatorFactory instantiates ResourceLocator objects given their corresponding locator-type strings. It uses the load-time factory registration scheme, meaning that it is a singleton and takes an instance of a Creator object (a ResourceLocatorCreator) in its "factory_register" method. Templated instances of the ResourceLocatorRegistrator classes should be placed in the library init.cc files (e.g. core/init/init.cc or protocols/init/init.ResourceLocatorRegistrators.ihh)
Ancestors (in MRO)
- ResourceLocatorFactory
- SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def create_resource_locator(
...)
create_resource_locator( (ResourceLocatorFactory)arg1, (str)locator_type, (str)locator_tag, (Tag)tags) -> ResourceLocator : Create a ResourceLocator given its locator_type, giving the newly created instance the name locator_tag
C++ signature :
boost::shared_ptr
def factory_register(
...)
factory_register( (ResourceLocatorFactory)arg1, (CPP_ResourceLocatorCreator)creator) -> None : This function is called on the singleton instance to give a ResourceLocatorCreator to the factory, usually through the constructor of a ResourceLocatorRegistrator class.
C++ signature :
void factory_register(basic::resource_manager::ResourceLocatorFactory {lvalue},boost::shared_ptr
def set_throw_on_double_registration(
...)
set_throw_on_double_registration( (ResourceLocatorFactory)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 between two ResourceLocatorCreators that register for the same name.
C++ signature : void set_throw_on_double_registration(basic::resource_manager::ResourceLocatorFactory {lvalue})
class ResourceLocatorFactoryAP
Ancestors (in MRO)
- ResourceLocatorFactoryAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLocatorFactoryAP)arg1) -> ResourceLocatorFactory :
C++ signature :
boost::shared_ptr
class ResourceLocatorFactoryCAP
Ancestors (in MRO)
- ResourceLocatorFactoryCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceLocatorFactoryCAP)arg1) -> ResourceLocatorFactory :
C++ signature :
boost::shared_ptr
class ResourceManager
The ResourceManager is a singleton class responsible for holding, distributing, and eventually deallocating resources which may be shared between multiple jobs. A protocol may communicate directly with the ResourceManager, requesting resources, but remaining unaware of where those resources came from, or whether the same resource is being used in multiple contexts. A protocol should request a resource using a "resource description" (a string), which is a generic way of referring to a piece of data. For example, a protocol might request the native Pose, by asking for a resource with the description "native". The ResourceManager's job is to return the resource matching that description; when the "native" is requested, it is requested in some context (e.g. in a protocol running under JD2) and the ResourceManager serves as a backbone in which to deliever context-specific data to the protocol, while keeping the protocol ignorant and independent of the surrounding context. That way protocols can run in JD2 just as effectively as the could run in some other job-management environment, without having to assume responsibility for instantiating resources themselves. NOTE: Because the logic for deciding which of the derived ResourceManager classes should be instantiated depends on the options system, the ResourceManager should not be requested until after core::init::init() has been called (i.e. it should not be requested at load time.)
Ancestors (in MRO)
- ResourceManager
- SingletonBase_T_basic_resource_manager_ResourceManager_T
- Boost.Python.instance
- __builtin__.object
Methods
def clear(
...)
clear( (ResourceManager)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::ResourceManager {lvalue})
def find_resource(
...)
find_resource( (ResourceManager)arg1, (str)resource_tag) -> object : Get a resource with a given name.
C++ signature :
boost::shared_ptr
def get_option(
...)
get_option( (ResourceManager)arg1, (object)key) -> bool : The following 12 functions allow protocols to request options that may have been set for the context in which the protocol is being run. Retrieve the boolean value represented by the given option key
C++ signature :
bool get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_bool : Retrieve the vector of boolean values represented by the given option key
C++ signature :
utility::vector1<bool, std::allocator<bool> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> FileName : Retrieve the FileName value represented by the given option key
C++ signature :
utility::file::FileName get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> object : Retrieve the vector of FileName values represented by the given option key
C++ signature :
utility::vector1<utility::file::FileName, std::allocator<utility::file::FileName> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> int : Retrieve the integer value represented by the given option key
C++ signature :
int get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_int : Retrieve the vector of integer values represented by the given option key
C++ signature :
utility::vector1<int, std::allocator<int> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> PathName : Retrieve the PathName value represented by the given option key
C++ signature :
utility::file::PathName get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> object : Retrieve the vector of PathName values represented by the given option key
C++ signature :
utility::vector1<utility::file::PathName, std::allocator<utility::file::PathName> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> float : Retrieve the Real value represented by the given option key
C++ signature :
double get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_Real : Retrieve the vector of Real values represented by the given option key
C++ signature :
utility::vector1<double, std::allocator<double> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealVectorOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> str : Retrieve the string value represented by the given option key
C++ signature :
std::string get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringOptionKey)
get_option( (ResourceManager)arg1, (object)key) -> vector1_string : Retrieve the vector of string values represented by the given option key
C++ signature :
utility::vector1<std::string, std::allocator<std::string> > get_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringVectorOptionKey)
get_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void get_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringVectorOptionKey)
def get_resource(
...)
get_resource( (ResourceManager)arg1, (str)resource_description) -> object : Returns the resource with the given resource_description.
C++ signature :
boost::shared_ptr<utility::pointer::ReferenceCount> get_resource(basic::resource_manager::ResourceManager {lvalue},std::string)
get_resource( (ResourceManager)arg1, (str)arg2) -> None :
C++ signature :
void get_resource(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},std::string)
def has_option(
...)
has_option( (ResourceManager)arg1, (object)key) -> bool : The following 12 functions allow protocols to request if a particular option has been set (e.g. on the command line or for the current job). Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::BooleanVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::BooleanVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::FileVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::FileVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::IntegerVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::IntegerVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::PathVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::PathVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::RealVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::RealVectorOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringOptionKey)
has_option( (ResourceManager)arg1, (object)key) -> bool : Return whether or not a value has been provided for the given option key either on the command line or through for the current job.
C++ signature :
bool has_option(basic::resource_manager::ResourceManager {lvalue},utility::options::StringVectorOptionKey)
has_option( (ResourceManager)arg1, (object)arg2) -> None :
C++ signature :
void has_option(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},utility::options::StringVectorOptionKey)
def has_resource(
...)
has_resource( (ResourceManager)arg1, (str)resource_tag) -> bool : Does a resource with a given name exist?
C++ signature : bool has_resource(basic::resource_manager::ResourceManager {lvalue},std::string)
def has_resource_with_description(
...)
has_resource_with_description( (ResourceManager)arg1, (str)resource_description) -> bool : A protocol may ask whether a resource with a given resource description has been provided. It is possible that some resources are available sometimes when running a protocol, but not always (e.g. when running abinitio, sometimes you don't know what the native structure is).
C++ signature :
bool has_resource_with_description(basic::resource_manager::ResourceManager {lvalue},std::string)
has_resource_with_description( (ResourceManager)arg1, (str)arg2) -> None :
C++ signature :
void has_resource_with_description(boost::shared_ptr<basic::resource_manager::ResourceManager> {lvalue},std::string)
def show(
...)
show( (ResourceManager)arg1, (OStream)out) -> None : basic/resource_manager/ResourceManager.hh:125
C++ signature : void show(basic::resource_manager::ResourceManager {lvalue},std::ostream {lvalue})
class ResourceManagerAP
Ancestors (in MRO)
- ResourceManagerAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceManagerAP)arg1) -> ResourceManager :
C++ signature :
boost::shared_ptr
class ResourceManagerCAP
Ancestors (in MRO)
- ResourceManagerCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceManagerCAP)arg1) -> ResourceManager :
C++ signature :
boost::shared_ptr
class ResourceManagerCreator
Derived classes will be used by the ResourceManagerFactory to decide which of the various ResourceManagers should be instantiated. The ResourceManager is a singleton, but, different ResourceManagers can be instantiated in different contexts.
Ancestors (in MRO)
- ResourceManagerCreator
- Boost.Python.instance
- __builtin__.object
class ResourceManagerCreatorAP
Ancestors (in MRO)
- ResourceManagerCreatorAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceManagerCreatorAP)arg1) -> ResourceManagerCreator :
C++ signature :
boost::shared_ptr
class ResourceManagerCreatorCAP
Ancestors (in MRO)
- ResourceManagerCreatorCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceManagerCreatorCAP)arg1) -> ResourceManagerCreator :
C++ signature :
boost::shared_ptr
class ResourceManagerFactory
A factory class for managing the instantiation of the singleton ResourceManager: only one of the various derived classes will be instantiated. Currently, it asks for the JD2ResourceManager; in the future, this should be fixed so that it reads from the options system to figure out which ResourceManager to instantiate.
Ancestors (in MRO)
- ResourceManagerFactory
- SingletonBase_T_basic_resource_manager_ResourceManagerFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def create_resource_manager_from_options_system(
...)
create_resource_manager_from_options_system( (ResourceManagerFactory)arg1) -> ResourceManager : Should only be called by the ResourceManager in its singleton construction!
C++ signature : basic::resource_manager::ResourceManager* create_resource_manager_from_options_system(basic::resource_manager::ResourceManagerFactory {lvalue})
def factory_register(
...)
factory_register( (ResourceManagerFactory)arg1, (ResourceManagerCreator)creator) -> None : basic/resource_manager/ResourceManagerFactory.hh:58
C++ signature :
void factory_register(basic::resource_manager::ResourceManagerFactory {lvalue},boost::shared_ptr
class ResourceManagerFactoryAP
Ancestors (in MRO)
- ResourceManagerFactoryAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceManagerFactoryAP)arg1) -> ResourceManagerFactory :
C++ signature :
boost::shared_ptr
class ResourceManagerFactoryCAP
Ancestors (in MRO)
- ResourceManagerFactoryCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceManagerFactoryCAP)arg1) -> ResourceManagerFactory :
C++ signature :
boost::shared_ptr
class ResourceOptions
The %ResourceOptions class is responsible for describing all the data requried for instanting a particular resource, except for the data stream (i.e. the file) that contains the data for the resource. For example, when reading in a PDB file, there are 30 different options for how that PDB file should be turned into a Pose. That data is now held in an ImportPoseOptions object. The purpose of the %ResourceOptions class is to allow different jobs to load resources in different ways, or for one job to load two different resources of the same type in different ways. For example, a protocol may need both a centroid pose and a fullatom pose to be loaded in from disk; however, if the logic for loading a pose in from disk is controlled by the options system alone, this becomes impossible.
Ancestors (in MRO)
- ResourceOptions
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def name(
...)
name( (ResourceOptions)arg1) -> str : A name given to a particular ResourceOptions instance. This function allows for better error message delivery.
C++ signature :
std::string name(basic::resource_manager::ResourceOptions {lvalue})
name( (ResourceOptions)arg1, (str)setting) -> None : Set the name for this %ResoureOptions instance.
C++ signature :
void name(basic::resource_manager::ResourceOptions {lvalue},std::string)
def parse_my_tag(
...)
parse_my_tag( (ResourceOptions)arg1, (Tag)tag) -> None : Initialize from the recursive "tag" structure.
C++ signature :
void parse_my_tag(basic::resource_manager::ResourceOptions {lvalue},boost::shared_ptr<utility::tag::Tag const>)
parse_my_tag( (ResourceOptions)arg1, (Tag)arg2) -> None :
C++ signature :
void parse_my_tag(boost::shared_ptr<ResourceOptions_exposer_callback> {lvalue},boost::shared_ptr<utility::tag::Tag const>)
def show(
...)
show( (ResourceOptions)arg1, (OStream)out) -> None : Describe this instance to a given output stream
C++ signature :
void show(basic::resource_manager::ResourceOptions {lvalue},std::ostream {lvalue})
show( (ResourceOptions)arg1, (OStream)out) -> None :
C++ signature :
void show(ResourceOptions_exposer_callback {lvalue},std::ostream {lvalue})
def type(
...)
type( (ResourceOptions)arg1) -> str : The class name (its type) for a particular ResourceOptions instance. This function allows for better error message delivery.
C++ signature :
std::string type(basic::resource_manager::ResourceOptions {lvalue})
type( (ResourceOptions)arg1) -> None :
C++ signature :
void type(boost::shared_ptr<ResourceOptions_exposer_callback> {lvalue})
class ResourceOptionsAP
Ancestors (in MRO)
- ResourceOptionsAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceOptionsAP)arg1) -> ResourceOptions :
C++ signature :
boost::shared_ptr
class ResourceOptionsCAP
Ancestors (in MRO)
- ResourceOptionsCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceOptionsCAP)arg1) -> ResourceOptions :
C++ signature :
boost::shared_ptr
class ResourceOptionsCreator
Each derived %ResourceOptionsCreator class is responsible for instantiating a (specific) derived ResourceOptions class, and for telling the ResourceOptionsFactory the string which identifies that class. There should be one derived ResourceOptionsCreator class for each ResourceOptions class.
Ancestors (in MRO)
- ResourceOptionsCreator
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def create_options(
...)
create_options( (ResourceOptionsCreator)arg1) -> ResourceOptions : basic/resource_manager/ResourceOptionsCreator.hh:44
C++ signature :
boost::shared_ptr<basic::resource_manager::ResourceOptions> create_options(basic::resource_manager::ResourceOptionsCreator {lvalue})
create_options( (ResourceOptionsCreator)arg1) -> None :
C++ signature :
void create_options(boost::shared_ptr<ResourceOptionsCreator_exposer_callback> {lvalue})
def options_type(
...)
options_type( (ResourceOptionsCreator)arg1) -> str : basic/resource_manager/ResourceOptionsCreator.hh:43
C++ signature :
std::string options_type(basic::resource_manager::ResourceOptionsCreator {lvalue})
options_type( (ResourceOptionsCreator)arg1) -> None :
C++ signature :
void options_type(boost::shared_ptr<ResourceOptionsCreator_exposer_callback> {lvalue})
class ResourceOptionsCreatorAP
Ancestors (in MRO)
- ResourceOptionsCreatorAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceOptionsCreatorAP)arg1) -> ResourceOptionsCreator :
C++ signature :
boost::shared_ptr
class ResourceOptionsCreatorCAP
Ancestors (in MRO)
- ResourceOptionsCreatorCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceOptionsCreatorCAP)arg1) -> ResourceOptionsCreator :
C++ signature :
boost::shared_ptr
class ResourceOptionsFactory
The %ResourceOptionsFactory class is responsible for maintaining the map between the names of the ResourceOptions classes (strings) and the ResourceOptionsCreator classes that are responsible for instantiating the ResourceOption classes. This is a singleton class. It is initialized at load time -- or at least after the call to devel::init( argc, argv ) -- and populated with the help of ResourceOptionsRegistrator instances.
Ancestors (in MRO)
- ResourceOptionsFactory
- SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def create_resource_options(
...)
create_resource_options( (ResourceOptionsFactory)arg1, (str)options_type, (Tag)tag) -> ResourceOptions : Create an instance of a ResourceOptions class given the name of the class (options_type) and initialize it from the given tag object. Throws an EXCN_Msg_Exception exception if the options_type string is not recognized.
C++ signature :
boost::shared_ptr
def factory_register(
...)
factory_register( (ResourceOptionsFactory)arg1, (CPP_ResourceOptionsCreator)creator) -> None : Register the given ResourceOptionsCreator object with the factory. Invoked by an instance of the templated ResourceOptionsRegistrator class.
C++ signature :
void factory_register(basic::resource_manager::ResourceOptionsFactory {lvalue},boost::shared_ptr
def set_throw_on_double_registration(
...)
set_throw_on_double_registration( (ResourceOptionsFactory)arg1) -> None : Instruct the %ResourceOptionsFactory to throw an exception if two ResourceOptionCreators are registered with the factory that report the same "options_type" string instead of invoking utility_exit_with_message.
C++ signature : void set_throw_on_double_registration(basic::resource_manager::ResourceOptionsFactory {lvalue})
class ResourceOptionsFactoryAP
Ancestors (in MRO)
- ResourceOptionsFactoryAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceOptionsFactoryAP)arg1) -> ResourceOptionsFactory :
C++ signature :
boost::shared_ptr
class ResourceOptionsFactoryCAP
Ancestors (in MRO)
- ResourceOptionsFactoryCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceOptionsFactoryCAP)arg1) -> ResourceOptionsFactory :
C++ signature :
boost::shared_ptr
class ResourceStream
The %ResourceStream represents an abstract class for packaging up a standard istream so that data that the ResourceLocator needs to deliver to a ResourceLoader can come from arbitrary sources (e.g. from either a file or from a database).
Ancestors (in MRO)
- ResourceStream
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def stream(
...)
stream( (ResourceStream)arg1) -> std_istream : Return an istream reference so that the ResourceLoader can access arbitrary data returned by the %ResourceLocator
C++ signature :
std::istream {lvalue} stream(basic::resource_manager::ResourceStream {lvalue})
stream( (ResourceStream)arg1) -> None :
C++ signature :
void stream(boost::shared_ptr<ResourceStream_exposer_callback> {lvalue})
class ResourceStreamAP
Ancestors (in MRO)
- ResourceStreamAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceStreamAP)arg1) -> ResourceStream :
C++ signature :
boost::shared_ptr
class ResourceStreamCAP
Ancestors (in MRO)
- ResourceStreamCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (ResourceStreamCAP)arg1) -> ResourceStream :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way. The derived class must a) implement a private, static function: T * create_singleton_instance() so that the SingletonBase class can invoke this function, and b) declare the SingletonBase class to be a friend, so that it can invoke this function The .cc file in which the derived singleton must be put will need to include the definitions for the two static data members, instance_ and singleton_mutex_.
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
class SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_TAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_TAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_TAP)arg1) -> SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_TCAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_TCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_TCAP)arg1) -> SingletonBase_T_basic_resource_manager_FallbackConfigurationFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way. The derived class must a) implement a private, static function: T * create_singleton_instance() so that the SingletonBase class can invoke this function, and b) declare the SingletonBase class to be a friend, so that it can invoke this function The .cc file in which the derived singleton must be put will need to include the definitions for the two static data members, instance_ and singleton_mutex_.
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
class SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_TAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_TAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_TAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_TCAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_TCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_TCAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceLoaderFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way. The derived class must a) implement a private, static function: T * create_singleton_instance() so that the SingletonBase class can invoke this function, and b) declare the SingletonBase class to be a friend, so that it can invoke this function The .cc file in which the derived singleton must be put will need to include the definitions for the two static data members, instance_ and singleton_mutex_.
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
class SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_TAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_TAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_TAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_TCAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_TCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_TCAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceLocatorFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceManagerFactory_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way. The derived class must a) implement a private, static function: T * create_singleton_instance() so that the SingletonBase class can invoke this function, and b) declare the SingletonBase class to be a friend, so that it can invoke this function The .cc file in which the derived singleton must be put will need to include the definitions for the two static data members, instance_ and singleton_mutex_.
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceManagerFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
class SingletonBase_T_basic_resource_manager_ResourceManagerFactory_TAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceManagerFactory_TAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceManagerFactory_TAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceManagerFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceManagerFactory_TCAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceManagerFactory_TCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceManagerFactory_TCAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceManagerFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceManager_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way. The derived class must a) implement a private, static function: T * create_singleton_instance() so that the SingletonBase class can invoke this function, and b) declare the SingletonBase class to be a friend, so that it can invoke this function The .cc file in which the derived singleton must be put will need to include the definitions for the two static data members, instance_ and singleton_mutex_.
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceManager_T
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
class SingletonBase_T_basic_resource_manager_ResourceManager_TAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceManager_TAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceManager_TAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceManager_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceManager_TCAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceManager_TCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceManager_TCAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceManager_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_T
SingletonBase is meant to serve as a base class for singleton classes in Rosetta handling the initialization of the singleton in a thread-safe way. The derived class must a) implement a private, static function: T * create_singleton_instance() so that the SingletonBase class can invoke this function, and b) declare the SingletonBase class to be a friend, so that it can invoke this function The .cc file in which the derived singleton must be put will need to include the definitions for the two static data members, instance_ and singleton_mutex_.
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_T
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
class SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_TAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_TAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_TAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_T :
C++ signature :
boost::shared_ptr
class SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_TCAP
Ancestors (in MRO)
- SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_TCAP
- Boost.Python.instance
- __builtin__.object
Methods
def __init__(
...)
init( (object)arg1) -> None :
C++ signature : void init(_object*)
def get(
...)
get( (SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_TCAP)arg1) -> SingletonBase_T_basic_resource_manager_ResourceOptionsFactory_T :
C++ signature :
boost::shared_ptr