Changeset 14d898 for molecuilder/src/World.hpp

Timestamp:

Mar 3, 2010, 3:46:03 PM (16 years ago)

Author:

Tillmann Crueger <crueger@…>

Children:

3746aeb

Parents:

78b9d9

Message:

Added methods for querying molecules using descriptors

File:

• molecuilder/src/World.hpp (modified) (5 diffs)

molecuilder/src/World.hpp

@@ -27 +27 @@
 class AtomDescriptor;
 class AtomDescriptor_impl;
+class MoleculeDescriptor;
+class MoleculeDescriptor_impl;
 class ManipulateAtomsProcess;
 template<typename T>
@@ -36 +38 @@
 friend class AtomDescriptor_impl;
 friend class AtomDescriptor;
+friend class MoleculeDescriptor_impl;
+friend class MoleculeDescriptor;
 
 // Actions, calculations etc associated with the World
@@ -77 +81 @@
 
   /**
+   * returns the first molecule that matches a given descriptor.
+   * Do not rely on ordering for descriptors that match more than one molecule.
+   */
+  molecule *getMolecule(MoleculeDescriptor descriptor);
+
+  /**
+   * returns a vector containing all molecules that match a given descriptor
+   */
+  std::vector<molecule*> getAllMolecules(MoleculeDescriptor descriptor);
+
+  /**
    * get the number of molecules in the World
    */
@@ -125 +140 @@
 protected:
   /**** Iterators to use internal data structures */
+
+  // Atoms
+
   class AtomIterator {
   public:
@@ -163 +181 @@
   AtomSet::iterator atomEnd();
 
+  // Molecules
+
+  class MoleculeIterator {
+  public:
+    MoleculeIterator();
+    MoleculeIterator(MoleculeDescriptor, World*);
+    MoleculeIterator(const MoleculeIterator&);
+    MoleculeIterator& operator=(const MoleculeIterator&);
+    MoleculeIterator& operator++();     // prefix
+    MoleculeIterator  operator++(int);  // postfix with dummy parameter
+    bool operator==(const MoleculeIterator&);
+    bool operator==(const MoleculeSet::iterator&);
+    bool operator!=(const MoleculeIterator&);
+    bool operator!=(const MoleculeSet::iterator&);
+    molecule* operator*();
+
+    int getCount();
+  protected:
+    void advanceState();
+    MoleculeSet::iterator state;
+    boost::shared_ptr<MoleculeDescriptor_impl>  descr;
+    int index;
+
+    World* world;
+  };
+
+  /**
+   * returns an iterator over all Molecules matching a given descriptor.
+   * used for internal purposes, like MoleculeProcesses and MoleculeCalculations.
+   */
+  MoleculeIterator getMoleculeIter(MoleculeDescriptor descr);
+
+  /**
+   * returns an iterator to the end of the MoleculeSet. Due to overloading this iterator
+   * can be compared to iterators produced by getMoleculeIter (see the mis-matching types).
+   * Thus it can be used to detect when such an iterator is at the end of the list.
+   * used for internal purposes, like MoleculeProcesses and MoleculeCalculations.
+   */
+  MoleculeSet::iterator moleculeEnd();
+
+
   /******* Internal manipulation routines for double callback and Observer mechanism ******/
   void doManipulate(ManipulateAtomsProcess *);