Class ResourceOptions

 object --+    
          |    
??.instance --+
              |
             ResourceOptions

Known Subclasses:

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.

Instance Methods

[hide private]

__init__(...)
__init__( (object)arg1) -> None :

__reduce__(...)
helper for pickle

__str__(...)
__str__( (ResourceOptions)arg1) -> object :

name(...)
name( (ResourceOptions)arg1) -> str : A name given to a particular ResourceOptions instance.

parse_my_tag(...)
parse_my_tag( (ResourceOptions)arg1, (Tag)tag) -> None : Initialize from the recursive "tag" structure.

show(...)
show( (ResourceOptions)arg1, (OStream)out) -> None : Describe this instance to a given output stream

type(...)
type( (ResourceOptions)arg1) -> str : The class name (its type) for a particular ResourceOptions instance.

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__( (ResourceOptions)arg1) -> object :

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

Overrides: object.__str__

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)

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

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

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 ResourceOptions

__init__(...) (Constructor)

__reduce__(...)

__str__(...) (Informal representation operator)

name(...)

parse_my_tag(...)

show(...)

type(...)

init(...)
(Constructor)

reduce(...)

str(...)
(Informal representation operator)