OpenMS  3.0.0
BaseVisualizer.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg$
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
40 namespace OpenMS
41 {
52  template <typename ObjectType>
53  class OPENMS_GUI_DLLAPI BaseVisualizer
54  {
55 public:
56 
58  void load(ObjectType& o)
59  {
60  ptr_ = &o;
61  temp_ = o;
62 
63  update_();
64  }
65 
66  virtual ~BaseVisualizer() {}
67 
68 protected:
69 
71  ObjectType* ptr_;
73  ObjectType temp_;
74 
75 protected:
76 
78  virtual void update_()
79  {
80  }
81 
82  };
83 
84 
85 }
OpenMS::BaseVisualizer::update_
virtual void update_()
Updates the GUI from the temp_ variable.
Definition: BaseVisualizer.h:78
OpenMS::BaseVisualizer::load
void load(ObjectType &o)
Loads the object that is to be edited.
Definition: BaseVisualizer.h:58
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::BaseVisualizer::ptr_
ObjectType * ptr_
Pointer to the object that is currently edited.
Definition: BaseVisualizer.h:71
OpenMS::BaseVisualizer::temp_
ObjectType temp_
Copy of current object used to restore the original values.
Definition: BaseVisualizer.h:73
OpenMS::BaseVisualizer
A base class for all visualizer classes.
Definition: BaseVisualizer.h:53
OpenMS::BaseVisualizer::~BaseVisualizer
virtual ~BaseVisualizer()
Definition: BaseVisualizer.h:66