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

Class JobOptions

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

Instance Methods [hide private]
 
__init__(...)
__init__( (object)arg1) -> None :
 
__reduce__(...)
helper for pickle
 
__str__(...)
__str__( (JobOptions)arg1) -> object :
 
add_option(...)
add_option( (JobOptions)arg1, (object)key, (bool)val) -> None : Set the value for the indicated boolean option
 
get_option(...)
get_option( (JobOptions)arg1, (object)key) -> bool : Return the value of the indicated boolean option
 
has_option(...)
has_option( (JobOptions)arg1, (object)key) -> bool : Return true if a value for the indicated boolean option has been set
 
show(...)
show( (JobOptions)arg1, (OStream)out) -> None : Describe this %JobOptions to the given output stream

Inherited from unreachable.instance: __new__

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

Class Variables [hide private]
  __instance_size__ = 32
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

__str__(...)
(Informal representation operator)

 

__str__( (JobOptions)arg1) -> object :

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

Overrides: object.__str__

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> >)

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)

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)

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})