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]  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 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:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	4958 byte(s)
Log Message:	updated copyright notices
#	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] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40	* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	*/
42
43	#ifndef SELECTION_SELECTIONMANAGER_HPP
44	#define SELECTION_SELECTIONMANAGER_HPP
45
46	#include "utils/OpenMDBitSet.hpp"
47	#include "primitives/StuntDouble.hpp"
48	namespace OpenMD {
49
50	class SimInfo;
51	/**
52	* @class SelectionManager SelectionManager.hpp "selection/SelectionManager.hpp"
53	* @brief
54	*/
55	class SelectionManager {
56	public:
57	SelectionManager(SimInfo* info);
58
59	void addSelection(StuntDouble* sd) {
60	bsSelection_.setBitOn(sd->getGlobalIndex());
61	}
62
63	void addSelectionSet(const OpenMDBitSet& bs) {
64	bsSelection_ \|= bs;
65	}
66
67	void setSelection(StuntDouble* sd) {
68	bsSelection_.clearAll();
69	bsSelection_.setBitOn(sd->getGlobalIndex());
70	}
71
72	void setSelectionSet(const OpenMDBitSet& bs) {
73	bsSelection_ = bs;
74	}
75
76	void toggleSelection(StuntDouble* sd) {
77	bsSelection_.flip(sd->getGlobalIndex());
78	}
79
80	void toggleSelection() {
81	bsSelection_.flip();
82	}
83
84	void selectAll() {
85	bsSelection_.setAll();
86	}
87
88	void clearSelection() {
89	bsSelection_.clearAll();
90	}
91
92	void clearSelection(StuntDouble* sd) {
93	bsSelection_.setBitOff(sd->getGlobalIndex());
94	}
95
96	bool isSelected(StuntDouble* sd) {
97	return bsSelection_[sd->getGlobalIndex()];
98	}
99
100	bool isEmpty() {
101	return bsSelection_.none();
102	}
103
104	int getSelectionCount() {
105	return bsSelection_.countBits();
106	}
107
108	OpenMDBitSet getSelectionSet() {
109	return bsSelection_;
110	}
111
112
113	StuntDouble* beginSelected(int& i);
114	StuntDouble* nextSelected(int& i);
115
116	StuntDouble* beginUnselected(int& i);
117	StuntDouble* nextUnSelected(int& i);
118
119	SelectionManager& operator&= (const SelectionManager &sman) {
120	bsSelection_ &= sman.bsSelection_;
121	return *this;
122	}
123
124	SelectionManager& operator\|= (const SelectionManager &sman) {
125	bsSelection_ \|= sman.bsSelection_;
126	return *this;
127	}
128
129	SelectionManager& operator^= (const SelectionManager &sman) {
130	bsSelection_ ^= sman.bsSelection_;
131	return *this;
132	}
133
134	SelectionManager& operator-= (const SelectionManager &sman) {
135	bsSelection_ -= sman.bsSelection_;
136	return *this;
137	}
138
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	friend SelectionManager operator-(const SelectionManager& sman1, const SelectionManager& sman2);
143
144	private:
145	SimInfo* info_;
146	OpenMDBitSet bsSelection_;
147	std::vector<StuntDouble*> stuntdoubles_;
148	};
149
150	}
151	#endif