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, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#ifndef SELECTION_SELECTIONMANAGER_HPP
#define SELECTION_SELECTIONMANAGER_HPP

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

  class SimInfo;
  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:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 8 months ago) by gezelter
File size:	4852 byte(s)
Log Message:	Fixed a widespread typo in the license
#	User	Rev	Content
1	tim	277	/*
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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	tim	277	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	tim	277	* 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	gezelter	1390	*
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	gezelter	1850	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	tim	277	*/
42
43			#ifndef SELECTION_SELECTIONMANAGER_HPP
44			#define SELECTION_SELECTIONMANAGER_HPP
45
46	gezelter	1390	#include "utils/OpenMDBitSet.hpp"
47	tim	288	#include "primitives/StuntDouble.hpp"
48	gezelter	1390	namespace OpenMD {
49	tim	277
50	gezelter	507	class SimInfo;
51			class SelectionManager {
52			public:
53			SelectionManager(SimInfo* info);
54	tim	277
55	gezelter	507	void addSelection(StuntDouble* sd) {
56			bsSelection_.setBitOn(sd->getGlobalIndex());
57			}
58	tim	283
59	gezelter	1390	void addSelectionSet(const OpenMDBitSet& bs) {
60	gezelter	507	bsSelection_ \|= bs;
61			}
62	tim	278
63	gezelter	507	void setSelection(StuntDouble* sd) {
64			bsSelection_.clearAll();
65			bsSelection_.setBitOn(sd->getGlobalIndex());
66			}
67	tim	278
68	gezelter	1390	void setSelectionSet(const OpenMDBitSet& bs) {
69	gezelter	507	bsSelection_ = bs;
70			}
71	tim	283
72	gezelter	507	void toggleSelection(StuntDouble* sd) {
73			bsSelection_.flip(sd->getGlobalIndex());
74			}
75	tim	283
76	gezelter	507	void toggleSelection() {
77			bsSelection_.flip();
78			}
79	tim	283
80	gezelter	507	void selectAll() {
81			bsSelection_.setAll();
82			}
83	tim	283
84	gezelter	507	void clearSelection() {
85			bsSelection_.clearAll();
86			}
87	tim	283
88	gezelter	507	void clearSelection(StuntDouble* sd) {
89			bsSelection_.setBitOff(sd->getGlobalIndex());
90			}
91	tim	283
92	gezelter	507	bool isSelected(StuntDouble* sd) {
93			return bsSelection_[sd->getGlobalIndex()];
94			}
95	tim	283
96	gezelter	507	bool isEmpty() {
97			return bsSelection_.none();
98			}
99	tim	283
100	gezelter	507	int getSelectionCount() {
101			return bsSelection_.countBits();
102			}
103	tim	283
104	gezelter	1390	OpenMDBitSet getSelectionSet() {
105	gezelter	507	return bsSelection_;
106			}
107	tim	315
108
109	gezelter	507	StuntDouble* beginSelected(int& i);
110			StuntDouble* nextSelected(int& i);
111	tim	315
112	gezelter	507	StuntDouble* beginUnselected(int& i);
113			StuntDouble* nextUnSelected(int& i);
114	tim	353
115	gezelter	507	SelectionManager& operator&= (const SelectionManager &sman) {
116			bsSelection_ &= sman.bsSelection_;
117			return *this;
118			}
119	tim	283
120	gezelter	507	SelectionManager& operator\|= (const SelectionManager &sman) {
121			bsSelection_ \|= sman.bsSelection_;
122			return *this;
123			}
124	tim	353
125	gezelter	507	SelectionManager& operator^= (const SelectionManager &sman) {
126			bsSelection_ ^= sman.bsSelection_;
127			return *this;
128			}
129	tim	353
130	gezelter	507	SelectionManager& operator-= (const SelectionManager &sman) {
131			bsSelection_ -= sman.bsSelection_;
132			return *this;
133			}
134	tim	353
135	gezelter	507	friend SelectionManager operator\| (const SelectionManager& sman1, const SelectionManager& sman2);
136			friend SelectionManager operator& (const SelectionManager& sman1, const SelectionManager& sman2);
137			friend SelectionManager operator^ (const SelectionManager& sman1, const SelectionManager& sman2);
138			friend SelectionManager operator-(const SelectionManager& sman1, const SelectionManager& sman2);
139	tim	353
140	gezelter	507	private:
141			SimInfo* info_;
142	gezelter	1390	OpenMDBitSet bsSelection_;
143	gezelter	507	std::vector<StuntDouble*> stuntdoubles_;
144			};
145	tim	277
146			}
147			#endif