Fraxinus  16.5.0-fx-rc5
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxTrackerConfiguration.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 
33 #ifndef CXTRACKERCONFIGURATION_H
34 #define CXTRACKERCONFIGURATION_H
35 
36 #include "cxResourceExport.h"
37 
38 #include "boost/shared_ptr.hpp"
39 #include <QStringList>
40 
41 namespace cx
42 {
43 typedef boost::shared_ptr<class TrackerConfiguration> TrackerConfigurationPtr;
44 
52 class cxResource_EXPORT TrackerConfiguration
53 {
54 public:
56  {
57  QString mUid;
58  QString mName;
60  QString mTrackingSystem;
61  QStringList mTools;
62  QString mReferenceTool;
63  };
64  struct Tool
65  {
66  QString mUid; // absolute filename
67  QString mName; // User-friendly name
68  QString mTrackingSystem;
71  };
72 
73  virtual ~TrackerConfiguration() {}
74 
75  virtual QString getConfigurationApplicationsPath() = 0;
76  virtual void saveConfiguration(const Configuration& config) = 0;
77  virtual Configuration getConfiguration(QString uid) = 0;
78 
79  virtual QStringList getConfigurationsGivenApplication() = 0;
80  virtual QStringList getAllConfigurations() = 0;
81 
82  virtual QStringList getSupportedTrackingSystems() = 0;
83  virtual QStringList getToolsGivenFilter(QStringList applicationsFilter,
84  QStringList trackingsystemsFilter) = 0;
85  virtual QStringList getAllTools() = 0;
86  virtual QStringList getAllApplications() = 0;
87 
88  virtual Tool getTool(QString uid) = 0;
89  virtual bool verifyTool(QString uid) = 0;
90 
91  virtual bool isNull() = 0;
92  static TrackerConfigurationPtr getNullObject();
93 };
94 
95 } // namespace cx
96 
97 #endif // CXTRACKERCONFIGURATION_H
Interface to a tool, i.e. a pointer, US probe or similar.
Definition: cxTool.h:82
boost::shared_ptr< class TrackerConfiguration > TrackerConfigurationPtr
QString mUid
absolute path and filename for the new config file