Home       Trees       Indices       Help   
Package rosetta :: Package core :: Package chemical :: Module _core_chemical_ :: Class ResidueProperties
[hide private]
[frames] | no frames]

Class ResidueProperties

 object --+    
          |    
??.instance --+
              |
             ResidueProperties

This is a container class for the large assortment of properties associated with ResidueTypes. It prevents ResidueType from becoming cluttered with an over-abundance of properties and related methods. @remarks This is the first step in a major refactor of how properties are handled in Rosetta. For now, I have just gathered all the properties related code into one place, so that changes to the system can be more readily made. Previous behavior has been maintained. In the future, I have several ideas for further improvements. ~Labonte

Instance Methods [hide private]
 
__init__(...)
__init__( (object)arg1, (ResidueType)residue_type) -> None : Constructor with owning ResidueType
 
__reduce__(...)
helper for pickle
 
__str__(...)
__str__( (ResidueProperties)arg1) -> object :
 
add_numeric_property(...)
add_numeric_property( (ResidueProperties)arg1, (str)tag, (float)value) -> None : Add a numeric property.
 
add_string_property(...)
add_string_property( (ResidueProperties)arg1, (str)tag, (str)value) -> None : Add a string property.
 
enable_custom_variant_types(...)
enable_custom_variant_types( (ResidueProperties)arg1) -> None : Turn on the ability to create VariantTypes "on-the-fly".
 
get_list_of_custom_variants(...)
get_list_of_custom_variants( (ResidueProperties)arg1) -> vector1_string : Return a list of custom VariantTypes only for this ResidueType.
 
get_list_of_properties(...)
get_list_of_properties( (ResidueProperties)arg1) -> vector1_string : Generate and return a list of strings representing the properties of this ResidueType.
 
get_list_of_variants(...)
get_list_of_variants( (ResidueProperties)arg1) -> vector1_string : Generate and return a list of strings representing the VariantTypes of this ResidueType.
 
has_custom_variant_types(...)
has_custom_variant_types( (ResidueProperties)arg1) -> bool : Does this ResidueType contain additional VariantTypes than the standard list?
 
has_property(...)
has_property( (ResidueProperties)arg1, (ResidueProperty)property) -> bool : Get whether or not this ResidueType has the requested property.
 
is_variant_type(...)
is_variant_type( (ResidueProperties)arg1, (VariantType)variant_type) -> bool : Get whether or not this ResidueType is of the requested VariantType.
 
numeric_properties(...)
numeric_properties( (ResidueProperties)arg1) -> map_string_Real : core/chemical/ResidueProperties.hh:141
 
set_property(...)
set_property( (ResidueProperties)arg1, (ResidueProperty)property, (bool)setting) -> None : Set the status of the given property for this ResidueType.
 
set_variant_type(...)
set_variant_type( (ResidueProperties)arg1, (VariantType)variant_type, (bool)setting) -> None : Set the status of a given VariantType for this ResidueType.
 
show(...)
show( (ResidueProperties)arg1, (OStream)output) -> None : Generate string representation of ResidueProperties for debugging purposes.
 
string_properties(...)
string_properties( (ResidueProperties)arg1) -> map_string_string : core/chemical/ResidueProperties.hh:147

Inherited from unreachable.instance: __new__

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

Static Methods [hide private]
 
get_string_from_variant(...)
get_string_from_variant( (VariantType)variant) -> str : core/chemical/ResidueProperties.hh:212
 
get_variant_from_string(...)
get_variant_from_string( (str)variant) -> VariantType : core/chemical/ResidueProperties.hh:206
Class Variables [hide private]
  __instance_size__ = 32
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

  

__init__( (object)arg1, (ResidueType)residue_type) -> None :
    Constructor with owning ResidueType
    

    C++ signature :
        void __init__(_object*,core::chemical::ResidueType const*)

__init__( (object)arg1, (ResidueProperties)object_to_copy, (ResidueType)new_owner) -> None :
    Copy constructor
    

    C++ signature :
        void __init__(_object*,core::chemical::ResidueProperties,core::chemical::ResidueType const*)
Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

__str__(...)
(Informal representation operator)

  

__str__( (ResidueProperties)arg1) -> object :

    C++ signature :
        _object* __str__(core::chemical::ResidueProperties {lvalue})
Overrides: object.__str__

add_numeric_property(...)

  

add_numeric_property( (ResidueProperties)arg1, (str)tag, (float)value) -> None :
    Add a numeric property.
    

    C++ signature :
        void add_numeric_property(core::chemical::ResidueProperties {lvalue},std::string,double)

add_string_property(...)

  

add_string_property( (ResidueProperties)arg1, (str)tag, (str)value) -> None :
    Add a string property.
    

    C++ signature :
        void add_string_property(core::chemical::ResidueProperties {lvalue},std::string,std::string)

enable_custom_variant_types(...)

  

enable_custom_variant_types( (ResidueProperties)arg1) -> None :
    Turn on the ability to create VariantTypes "on-the-fly".
    Custom" VariantTypes as strings are permitted for the enzdes and metalloproteins cases.
    Do not enable unless you have a good reason to, as string look-ups are less efficient and more error-prone.
    

    C++ signature :
        void enable_custom_variant_types(core::chemical::ResidueProperties {lvalue})

get_list_of_custom_variants(...)

  

get_list_of_custom_variants( (ResidueProperties)arg1) -> vector1_string :
    Return a list of custom VariantTypes only for this ResidueType.
    

    C++ signature :
        utility::vector1<std::string, std::allocator<std::string> > get_list_of_custom_variants(core::chemical::ResidueProperties {lvalue})

get_list_of_properties(...)

  

get_list_of_properties( (ResidueProperties)arg1) -> vector1_string :
    Generate and return a list of strings representing the properties of this ResidueType.
    

    C++ signature :
        utility::vector1<std::string, std::allocator<std::string> > get_list_of_properties(core::chemical::ResidueProperties {lvalue})

get_list_of_variants(...)

  

get_list_of_variants( (ResidueProperties)arg1) -> vector1_string :
    Generate and return a list of strings representing the VariantTypes of this ResidueType.
    

    C++ signature :
        utility::vector1<std::string, std::allocator<std::string> > get_list_of_variants(core::chemical::ResidueProperties {lvalue})

get_string_from_variant(...)
Static Method

  

get_string_from_variant( (VariantType)variant) -> str :
    core/chemical/ResidueProperties.hh:212

    C++ signature :
        std::string get_string_from_variant(core::chemical::VariantType)

get_variant_from_string(...)
Static Method

  

get_variant_from_string( (str)variant) -> VariantType :
    core/chemical/ResidueProperties.hh:206

    C++ signature :
        core::chemical::VariantType get_variant_from_string(std::string)

has_custom_variant_types(...)

  

has_custom_variant_types( (ResidueProperties)arg1) -> bool :
    Does this ResidueType contain additional VariantTypes than the standard list?
    

    C++ signature :
        bool has_custom_variant_types(core::chemical::ResidueProperties {lvalue})

has_property(...)

  

has_property( (ResidueProperties)arg1, (ResidueProperty)property) -> bool :
    Get whether or not this ResidueType has the requested property.
    

    C++ signature :
        bool has_property(core::chemical::ResidueProperties {lvalue},core::chemical::ResidueProperty)

has_property( (ResidueProperties)arg1, (str)property) -> bool :
    Get whether or not this ResidueType has the requested property by string.
    

    C++ signature :
        bool has_property(core::chemical::ResidueProperties {lvalue},std::string)

is_variant_type(...)

  

is_variant_type( (ResidueProperties)arg1, (VariantType)variant_type) -> bool :
    Get whether or not this ResidueType is of the requested VariantType.
    

    C++ signature :
        bool is_variant_type(core::chemical::ResidueProperties {lvalue},core::chemical::VariantType)

is_variant_type( (ResidueProperties)arg1, (str)variant_type) -> bool :
    Get whether or not this ResidueType is of the requested VariantType by string.
    

    C++ signature :
        bool is_variant_type(core::chemical::ResidueProperties {lvalue},std::string)

numeric_properties(...)

  

numeric_properties( (ResidueProperties)arg1) -> map_string_Real :
    core/chemical/ResidueProperties.hh:141

    C++ signature :
        std::map<std::string, double, std::less<std::string>, std::allocator<std::pair<std::string const, double> > > numeric_properties(core::chemical::ResidueProperties {lvalue})

set_property(...)

  

set_property( (ResidueProperties)arg1, (ResidueProperty)property, (bool)setting) -> None :
    Set the status of the given property for this ResidueType.
    

    C++ signature :
        void set_property(core::chemical::ResidueProperties {lvalue},core::chemical::ResidueProperty,bool)

set_property( (ResidueProperties)arg1, (str)property, (bool)setting) -> None :
    Set the status of the given property for this ResidueType by string.
    

    C++ signature :
        void set_property(core::chemical::ResidueProperties {lvalue},std::string,bool)

set_variant_type(...)

  

set_variant_type( (ResidueProperties)arg1, (VariantType)variant_type, (bool)setting) -> None :
    Set the status of a given VariantType for this ResidueType.
    

    C++ signature :
        void set_variant_type(core::chemical::ResidueProperties {lvalue},core::chemical::VariantType,bool)

set_variant_type( (ResidueProperties)arg1, (str)variant_type, (bool)setting) -> None :
    Set the status of a given VariantType for this ResidueType by string.
    

    C++ signature :
        void set_variant_type(core::chemical::ResidueProperties {lvalue},std::string,bool)

show(...)

  

show( (ResidueProperties)arg1, (OStream)output) -> None :
    Generate string representation of ResidueProperties for debugging purposes.
    

    C++ signature :
        void show(core::chemical::ResidueProperties {lvalue},std::ostream {lvalue})

show( (ResidueProperties)arg1, (OStream)output) -> None :

    C++ signature :
        void show(ResidueProperties_exposer_callback {lvalue},std::ostream {lvalue})

string_properties(...)

  

string_properties( (ResidueProperties)arg1) -> map_string_string :
    core/chemical/ResidueProperties.hh:147

    C++ signature :
        std::map<std::string, std::string, std::less<std::string>, std::allocator<std::pair<std::string const, std::string> > > string_properties(core::chemical::ResidueProperties {lvalue})

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sat Jun 6 00:11:06 2015 http://epydoc.sourceforge.net