Package rosetta :: Package core :: Package chemical :: Module _core_chemical_ :: Class ElementSet
[hide private]
[frames] | no frames]

Class ElementSet

 object --+    
          |    
??.instance --+
              |
             ElementSet

A set of Bcl Elements This class contains a vector of pointers each of which points to an Element and the vector index is looked up by an element_name string in a map.

Instance Methods [hide private]
 
__getitem__(...)
__getitem__( (ElementSet)arg1, (int)index) -> Element : Lookup an Element by 1-based indexing
 
__init__(...)
__init__( (object)arg1) -> None :
 
__reduce__(...)
helper for pickle
 
contains_element_type(...)
contains_element_type( (ElementSet)arg1, (str)element_symbol) -> bool : Check if there is an element_type associated with an element_symbol string
 
element(...)
element( (ElementSet)arg1, (str)element_symbol) -> Element : Lookup the element index by the element_symbol string
 
element_index(...)
element_index( (ElementSet)arg1, (str)element_symbol) -> int : Lookup the element index by the element_symbol string
 
n_elements(...)
n_elements( (ElementSet)arg1) -> int : Number of elements in the set
 
read_file(...)
read_file( (ElementSet)arg1, (str)filename) -> None : Load the ElementSet from a file

Inherited from unreachable.instance: __new__

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

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

Inherited from object: __class__

Method Details [hide private]

__getitem__(...)
(Indexing operator)

 

__getitem__( (ElementSet)arg1, (int)index) -> Element :
    Lookup an Element by 1-based indexing
    

    C++ signature :
        boost::shared_ptr<core::chemical::Element const> __getitem__(core::chemical::ElementSet {lvalue},unsigned long)

__init__(...)
(Constructor)

 

__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

__init__( (object)arg1, (ElementSet)) -> None :
    A set of Bcl Elements
    This class contains a vector of pointers each of which points to an
    Element and the vector index is looked up by an element_name string
    in a map.
    

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

Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

contains_element_type(...)

 

contains_element_type( (ElementSet)arg1, (str)element_symbol) -> bool :
    Check if there is an element_type associated with an element_symbol string
    

    C++ signature :
        bool contains_element_type(core::chemical::ElementSet {lvalue},std::string)

element(...)

 

element( (ElementSet)arg1, (str)element_symbol) -> Element :
    Lookup the element index by the element_symbol string
    

    C++ signature :
        boost::shared_ptr<core::chemical::Element const> element(core::chemical::ElementSet {lvalue},std::string)

element_index(...)

 

element_index( (ElementSet)arg1, (str)element_symbol) -> int :
    Lookup the element index by the element_symbol string
    

    C++ signature :
        unsigned long element_index(core::chemical::ElementSet {lvalue},std::string)

n_elements(...)

 

n_elements( (ElementSet)arg1) -> int :
    Number of elements in the set
    

    C++ signature :
        unsigned long n_elements(core::chemical::ElementSet {lvalue})

read_file(...)

 

read_file( (ElementSet)arg1, (str)filename) -> None :
    Load the ElementSet from a file
    

    C++ signature :
        void read_file(core::chemical::ElementSet {lvalue},std::string)