Fraxinus  16.5.0-fx-rc9
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxSpaceProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 #ifndef CXSPACEPROPERTY_H_
33 #define CXSPACEPROPERTY_H_
34 
35 
36 #include "cxResourceExport.h"
37 
38 #include <QDomElement>
39 #include <QStringList>
40 #include "cxSpacePropertyBase.h"
41 #include "cxXmlOptionItem.h"
42 
43 namespace cx
44 {
45 
46 typedef boost::shared_ptr<class SpaceProperty> SpacePropertyPtr;
47 
51 class cxResource_EXPORT SpaceProperty: public SpacePropertyBase
52 {
53 Q_OBJECT
54 public:
58  static SpacePropertyPtr initialize(const QString& uid, QString name, QString help, Space value=Space(),
59  std::vector<Space> range=std::vector<Space>(), QDomNode root = QDomNode());
60  void setSpaceProvider(SpaceProviderPtr provider);
61 
62 public:
63  // inherited interface
64  virtual QString getDisplayName() const;
65  virtual QString getUid() const;
66  virtual bool setValue(const Space& value);
67  virtual Space getValue() const;
68  virtual QString getHelp() const;
69  virtual void setHelp(QString val);
70  virtual std::vector<Space> getValueRange() const;
71  virtual void setValueRange(std::vector<Space> range);
72  virtual QString convertRefObjectInternal2Display(QString internal);
73  virtual void setRefObjectDisplayNames(std::map<QString, QString> names);
74 
75  virtual bool isReadOnly() const { return mIsReadOnly; }
76  virtual bool getAllowOnlyValuesInRange() const { return mAllowOnlyValuesInRange; }
77  void setReadOnly(bool val);
78 
79 
80 signals:
81  void valueWasSet();
82 
83 private slots:
84  void providerChangedSlot();
85 private:
86  SpaceProperty();
87  QString mName;
88  QString mUid;
89  QString mHelp;
90  Space mValue;
91  std::vector<Space> mRange;
92  XmlOptionItem mStore;
93  std::map<QString, QString> mDisplayNames;
94  bool mIsReadOnly;
95  bool mAllowOnlyValuesInRange;
96 
97  SpaceProviderPtr mProvider;
98 };
99 
100 // --------------------------------------------------------
101 // --------------------------------------------------------
102 
103 
104 } // namespace cx
105 
106 #endif // CXSPACEPROPERTY_H_
boost::shared_ptr< class SpaceProvider > SpaceProviderPtr
boost::shared_ptr< class SpaceProperty > SpacePropertyPtr
Helper class for storing one string value in an xml document.
CoordinateSystem Space
Identification of a Coordinate system.
virtual bool isReadOnly() const
virtual bool getAllowOnlyValuesInRange() const