LOGO

RestFrames  v1.0.1
RestFrames HEP Event Analysis Software Library
CombinatoricState.hh
Go to the documentation of this file.
1 // RestFrames: particle physics event analysis library
3 // --------------------------------------------------------------------
4 // Copyright (c) 2014-2016, Christopher Rogan
14 // This file is part of RestFrames.
15 //
16 // RestFrames is free software; you can redistribute it and/or modify
17 // it under the terms of the GNU General Public License as published by
18 // the Free Software Foundation; either version 2 of the License, or
19 // (at your option) any later version.
20 //
21 // RestFrames is distributed in the hope that it will be useful,
22 // but WITHOUT ANY WARRANTY; without even the implied warranty of
23 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 // GNU General Public License for more details.
25 //
26 // You should have received a copy of the GNU General Public License
27 // along with RestFrames. If not, see <http://www.gnu.org/licenses/>.
29 
30 #ifndef CombinatoricState_HH
31 #define CombinatoricState_HH
32 
33 #include "RestFrames/State.hh"
34 
35 namespace RestFrames {
36 
37  class VisibleState;
38  class Jigsaw;
39 
41  // CombinatoricState class
43  class CombinatoricState : public State {
44  public:
45 
50  CombinatoricState(const std::string& sname, const std::string& stitle);
51 
54  virtual ~CombinatoricState();
55 
59  static CombinatoricState& Empty();
60 
62  virtual void Clear();
63 
70  virtual void AddFrame(const RestFrame& frame);
71 
81  virtual void SetParentJigsaw(Jigsaw& jigsaw);
82 
92  virtual void SetChildJigsaw(Jigsaw& jigsaw);
93 
99  virtual void Boost(const TVector3& B);
100 
104  virtual TLorentzVector GetFourVector() const;
105 
109  virtual RFCharge GetCharge() const;
110 
119 
121  void ClearElements();
122 
126  void AddElement(VisibleState& state);
127 
131  void AddElements(const VisibleStateList& states);
132 
136  VisibleStateList const& GetElements() const;
137 
141  int GetNElements() const;
142 
144  bool ContainsElement(const State& state) const;
145 
147  bool ContainsElement(const RFKey& key) const;
148 
154  VisibleState const& GetElement(const RFKey& key) const;
155 
157 
158  protected:
159  VisibleStateList m_Elements;
160 
161  private:
162  static CombinatoricState m_Empty;
163 
164  };
165 
166 }
167 
168 #endif
RestFrames::CombinatoricState::AddFrame
virtual void AddFrame(const RestFrame &frame)
Adds a frame (RestFrame) to this state.
Definition: CombinatoricState.cc:61
RestFrames::CombinatoricState::SetChildJigsaw
virtual void SetChildJigsaw(Jigsaw &jigsaw)
Sets the child jigsaw (Jigsaw) to jigsaw
Definition: CombinatoricState.cc:77
RestFrames::CombinatoricState
Definition: CombinatoricState.hh:43
RestFrames::RFCharge
Definition: RFCharge.hh:40
RestFrames::CombinatoricState::GetElements
VisibleStateList const & GetElements() const
Returns elements of this state.
Definition: CombinatoricState.cc:97
RestFrames::CombinatoricState::Empty
static CombinatoricState & Empty()
Returns empty CombinatoricState.
Definition: CombinatoricState.cc:52
RestFrames::RestFrame
abstract base class for all Frame objects
Definition: RestFrame.hh:45
RestFrames::CombinatoricState::AddElement
void AddElement(VisibleState &state)
Adds element to this state.
Definition: CombinatoricState.cc:87
RestFrames::RFList< VisibleState >
RestFrames::CombinatoricState::GetCharge
virtual RFCharge GetCharge() const
Returns charge of current frame.
Definition: CombinatoricState.cc:126
RestFrames::CombinatoricState::ContainsElement
bool ContainsElement(const State &state) const
Is state element contained in this state (true/false)
Definition: CombinatoricState.cc:109
RestFrames::CombinatoricState::GetFourVector
virtual TLorentzVector GetFourVector() const
Returns four-vector of current frame.
Definition: CombinatoricState.cc:122
RestFrames::VisibleState
Definition: VisibleState.hh:39
RestFrames::CombinatoricState::AddElements
void AddElements(const VisibleStateList &states)
Adds elements to this state.
Definition: CombinatoricState.cc:92
RestFrames::CombinatoricState::ClearElements
void ClearElements()
Clears all elements associated with this state.
Definition: CombinatoricState.cc:83
State.hh
RestFrames::CombinatoricState::GetNElements
int GetNElements() const
Returns number of elements in this state.
Definition: CombinatoricState.cc:101
RestFrames::CombinatoricState::CombinatoricState
CombinatoricState()
Empty constructor.
Definition: CombinatoricState.cc:48
RestFrames::CombinatoricState::SetParentJigsaw
virtual void SetParentJigsaw(Jigsaw &jigsaw)
Sets the parent jigsaw (Jigsaw) to jigsaw
Definition: CombinatoricState.cc:71
RestFrames::CombinatoricState::Clear
virtual void Clear()
Clears CombinatoricState of all connections to other objects.
Definition: CombinatoricState.cc:56
RestFrames::CombinatoricState::Boost
virtual void Boost(const TVector3 &B)
Boosts to different frame (RestFrame)
Definition: CombinatoricState.cc:117
RestFrames::Jigsaw
abstract base class for all Jigsaw objects
Definition: Jigsaw.hh:44
RestFrames::State
Abstract base class for all State objects.
Definition: State.hh:47
RestFrames::RFKey
Definition: RFKey.hh:38
RestFrames::CombinatoricState::GetElement
VisibleState const & GetElement(const RFKey &key) const
Returns element with key in this state.
Definition: CombinatoricState.cc:113