fw4spl
ActivityMsg.hpp
1 /* ***** BEGIN LICENSE BLOCK *****
2  * FW4SPL - Copyright (C) IRCAD, 2015.
3  * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
4  * published by the Free Software Foundation.
5  * ****** END LICENSE BLOCK ****** */
6 
7 #ifndef __FWACTIVITIES_REGISTRY_ACTIVITYMSG_HPP__
8 #define __FWACTIVITIES_REGISTRY_ACTIVITYMSG_HPP__
9 
10 #include "fwActivities/config.hpp"
11 #include "fwActivities/registry/Activities.hpp"
12 
13 #include <fwMedData/ActivitySeries.hpp>
14 
15 namespace fwActivities
16 {
17 
18 namespace registry
19 {
20 
25 class FWACTIVITIES_CLASS_API ActivityMsg
26 {
27 
28 public:
29 
30  typedef ::fwActivities::registry::ActivityAppConfig::ActivityAppConfigParamsType ParametersType;
31  typedef std::map<std::string, std::string> ReplaceMapType;
32 
33 
34  FWACTIVITIES_API ActivityMsg(const ::fwMedData::ActivitySeries::sptr &series,
35  const ::fwActivities::registry::ActivityInfo & info,
36  const ParametersType& parameters);
37 
38  FWACTIVITIES_API virtual ~ActivityMsg()
39  {
40  }
41 
43  bool isClosable() const
44  {
45  return m_closable;
46  }
47 
49  const std::string &getTitle() const
50  {
51  return m_title;
52  }
53 
55  const std::string &getTabID() const
56  {
57  return m_tabID;
58  }
59 
61  const std::string &getAppConfigID() const
62  {
63  return m_appConfigID;
64  }
65 
67  const std::string &getTabInfo() const
68  {
69  return m_tabInfo;
70  }
71 
73  const std::string &getIconPath() const
74  {
75  return m_iconPath;
76  }
77 
79  const std::string &getToolTip() const
80  {
81  return m_tooltip;
82  }
83 
85  const ::fwMedData::ActivitySeries::sptr &getActivitySeries() const
86  {
87  return m_series;
88  }
89 
91  const ReplaceMapType & getReplaceMap() const
92  {
93  return m_replaceMap;
94  }
95 
96 private:
97 
98  bool m_closable;
99  std::string m_title;
100  std::string m_tabID;
101  std::string m_appConfigID;
102  std::string m_tabInfo;
103  std::string m_iconPath;
104  std::string m_tooltip;
105  ::fwMedData::ActivitySeries::sptr m_series;
106  ReplaceMapType m_replaceMap;
107 };
108 
109 } // namespace registry
110 
111 } // namespace fwActivities
112 
113 #endif // __FWACTIVITIES_REGISTRY_ACTIVITYMSG_HPP__
114 
const std::string & getTitle() const
Return activity title.
Definition: ActivityMsg.hpp:49
Contains fwAtomsFilter::registry details.
const ReplaceMapType & getReplaceMap() const
Return the map of the string association to replace in config.
Definition: ActivityMsg.hpp:91
const std::string & getTabInfo() const
Return tab information.
Definition: ActivityMsg.hpp:67
const std::string & getTabID() const
Return tab identifier.
Definition: ActivityMsg.hpp:55
Activity information sent by signal to launch new activities in a tab.
Definition: ActivityMsg.hpp:25
const std::string & getAppConfigID() const
Return appConfig identifier.
Definition: ActivityMsg.hpp:61
const std::string & getIconPath() const
Return activity icon path.
Definition: ActivityMsg.hpp:73
bool isClosable() const
Return if the activity can be closed.
Definition: ActivityMsg.hpp:43
Namespace containing activities data and builder.
const ::fwMedData::ActivitySeries::sptr & getActivitySeries() const
Return activity series.
Definition: ActivityMsg.hpp:85
const std::string & getToolTip() const
Return tooltip.
Definition: ActivityMsg.hpp:79