src/selection/SelectionManager.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */

#ifndef SELECTION_SELECTIONMANAGER_HPP
#define SELECTION_SELECTIONMANAGER_HPP

#include "utils/OpenMDBitSet.hpp"
#include "primitives/StuntDouble.hpp"
namespace OpenMD {

  class SimInfo;
  /**
   * @class SelectionManager SelectionManager.hpp "selection/SelectionManager.hpp"
   * @brief
   */
  class SelectionManager {
  public:
    SelectionManager(SimInfo* info);

    void addSelection(StuntDouble* sd) {
      bsSelection_.setBitOn(sd->getGlobalIndex());
    }
        
    void addSelectionSet(const OpenMDBitSet& bs) {
      bsSelection_ |= bs;
    }

    void setSelection(StuntDouble* sd) {
      bsSelection_.clearAll();
      bsSelection_.setBitOn(sd->getGlobalIndex());
    }
        
    void setSelectionSet(const OpenMDBitSet& bs) {
      bsSelection_ = bs;           
    }

    void toggleSelection(StuntDouble* sd) {
      bsSelection_.flip(sd->getGlobalIndex());
    }

    void toggleSelection() {
      bsSelection_.flip();
    }
        
    void selectAll() {
      bsSelection_.setAll();                
    }

    void clearSelection() {
      bsSelection_.clearAll();
    }

    void clearSelection(StuntDouble* sd) {
      bsSelection_.setBitOff(sd->getGlobalIndex());
    }

    bool isSelected(StuntDouble* sd) {
      return bsSelection_[sd->getGlobalIndex()];
    }

    bool isEmpty() {
      return bsSelection_.none();
    }

    int getSelectionCount() {
      return bsSelection_.countBits();
    }

    OpenMDBitSet getSelectionSet() {
      return bsSelection_;
    }


    StuntDouble* beginSelected(int& i);
    StuntDouble* nextSelected(int& i);

    StuntDouble* beginUnselected(int& i);
    StuntDouble* nextUnSelected(int& i);

    SelectionManager& operator&= (const SelectionManager &sman) {
      bsSelection_ &= sman.bsSelection_;
      return *this; 
    }
        
    SelectionManager& operator|= (const SelectionManager &sman) {
      bsSelection_ |= sman.bsSelection_;
      return *this; 
    }
        
    SelectionManager& operator^= (const SelectionManager &sman) {
      bsSelection_ ^= sman.bsSelection_;
      return *this; 
    }

    SelectionManager& operator-= (const SelectionManager &sman) {
      bsSelection_ -= sman.bsSelection_;
      return *this; 
    }
        
    friend SelectionManager operator| (const SelectionManager& sman1, const SelectionManager& sman2);
    friend SelectionManager operator& (const SelectionManager& sman1, const SelectionManager& sman2);
    friend SelectionManager operator^ (const SelectionManager& sman1, const SelectionManager& sman2);
    friend SelectionManager operator-(const SelectionManager& sman1, const SelectionManager& sman2);
        
  private:
    SimInfo* info_;
    OpenMDBitSet bsSelection_;
    std::vector<StuntDouble*> stuntdoubles_;
  };

}
#endif
Revision:	1390
Committed:	Wed Nov 25 20:02:06 2009 UTC (15 years, 11 months ago) by gezelter
File size:	4892 byte(s)
Log Message:	Almost all of the changes necessary to create OpenMD out of our old project (OOPSE-4)
#	Content
1	/*
2	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	*
4	* The University of Notre Dame grants you ("Licensee") a
5	* non-exclusive, royalty free, license to use, modify and
6	* redistribute this software in source and binary code form, provided
7	* that the following conditions are met:
8	*
9	* 1. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
12	* 2. Redistributions in binary form must reproduce the above copyright
13	* notice, this list of conditions and the following disclaimer in the
14	* documentation and/or other materials provided with the
15	* distribution.
16	*
17	* This software is provided "AS IS," without a warranty of any
18	* kind. All express or implied conditions, representations and
19	* warranties, including any implied warranty of merchantability,
20	* fitness for a particular purpose or non-infringement, are hereby
21	* excluded. The University of Notre Dame and its licensors shall not
22	* be liable for any damages suffered by licensee as a result of
23	* using, modifying or distributing the software or its
24	* derivatives. In no event will the University of Notre Dame or its
25	* licensors be liable for any lost revenue, profit or data, or for
26	* direct, indirect, special, consequential, incidental or punitive
27	* damages, however caused and regardless of the theory of liability,
28	* arising out of the use of or inability to use software, even if the
29	* University of Notre Dame has been advised of the possibility of
30	* such damages.
31	*
32	* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33	* research, please cite the appropriate papers when you publish your
34	* work. Good starting points are:
35	*
36	* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37	* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39	* [4] Vardeman & Gezelter, in progress (2009).
40	*/
41
42	#ifndef SELECTION_SELECTIONMANAGER_HPP
43	#define SELECTION_SELECTIONMANAGER_HPP
44
45	#include "utils/OpenMDBitSet.hpp"
46	#include "primitives/StuntDouble.hpp"
47	namespace OpenMD {
48
49	class SimInfo;
50	/**
51	* @class SelectionManager SelectionManager.hpp "selection/SelectionManager.hpp"
52	* @brief
53	*/
54	class SelectionManager {
55	public:
56	SelectionManager(SimInfo* info);
57
58	void addSelection(StuntDouble* sd) {
59	bsSelection_.setBitOn(sd->getGlobalIndex());
60	}
61
62	void addSelectionSet(const OpenMDBitSet& bs) {
63	bsSelection_ \|= bs;
64	}
65
66	void setSelection(StuntDouble* sd) {
67	bsSelection_.clearAll();
68	bsSelection_.setBitOn(sd->getGlobalIndex());
69	}
70
71	void setSelectionSet(const OpenMDBitSet& bs) {
72	bsSelection_ = bs;
73	}
74
75	void toggleSelection(StuntDouble* sd) {
76	bsSelection_.flip(sd->getGlobalIndex());
77	}
78
79	void toggleSelection() {
80	bsSelection_.flip();
81	}
82
83	void selectAll() {
84	bsSelection_.setAll();
85	}
86
87	void clearSelection() {
88	bsSelection_.clearAll();
89	}
90
91	void clearSelection(StuntDouble* sd) {
92	bsSelection_.setBitOff(sd->getGlobalIndex());
93	}
94
95	bool isSelected(StuntDouble* sd) {
96	return bsSelection_[sd->getGlobalIndex()];
97	}
98
99	bool isEmpty() {
100	return bsSelection_.none();
101	}
102
103	int getSelectionCount() {
104	return bsSelection_.countBits();
105	}
106
107	OpenMDBitSet getSelectionSet() {
108	return bsSelection_;
109	}
110
111
112	StuntDouble* beginSelected(int& i);
113	StuntDouble* nextSelected(int& i);
114
115	StuntDouble* beginUnselected(int& i);
116	StuntDouble* nextUnSelected(int& i);
117
118	SelectionManager& operator&= (const SelectionManager &sman) {
119	bsSelection_ &= sman.bsSelection_;
120	return *this;
121	}
122
123	SelectionManager& operator\|= (const SelectionManager &sman) {
124	bsSelection_ \|= sman.bsSelection_;
125	return *this;
126	}
127
128	SelectionManager& operator^= (const SelectionManager &sman) {
129	bsSelection_ ^= sman.bsSelection_;
130	return *this;
131	}
132
133	SelectionManager& operator-= (const SelectionManager &sman) {
134	bsSelection_ -= sman.bsSelection_;
135	return *this;
136	}
137
138	friend SelectionManager operator\| (const SelectionManager& sman1, const SelectionManager& sman2);
139	friend SelectionManager operator& (const SelectionManager& sman1, const SelectionManager& sman2);
140	friend SelectionManager operator^ (const SelectionManager& sman1, const SelectionManager& sman2);
141	friend SelectionManager operator-(const SelectionManager& sman1, const SelectionManager& sman2);
142
143	private:
144	SimInfo* info_;
145	OpenMDBitSet bsSelection_;
146	std::vector<StuntDouble*> stuntdoubles_;
147	};
148
149	}
150	#endif