NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
tag-host.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2021 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_DETAIL_TAG_HOST_HPP
23 #define NDN_CXX_DETAIL_TAG_HOST_HPP
24 
26 #include "ndn-cxx/tag.hpp"
27 
28 #include <map>
29 
30 namespace ndn {
31 
34 class TagHost
35 {
36 public:
41  template<typename T>
42  shared_ptr<T>
43  getTag() const;
44 
49  template<typename T>
50  void
51  setTag(shared_ptr<T> tag) const;
52 
56  template<typename T>
57  void
58  removeTag() const;
59 
60 private:
61  mutable std::map<int, shared_ptr<Tag>> m_tags;
62 };
63 
64 template<typename T>
65 shared_ptr<T>
67 {
68  static_assert(std::is_base_of<Tag, T>::value, "T must inherit from Tag");
69 
70  auto it = m_tags.find(T::getTypeId());
71  if (it == m_tags.end()) {
72  return nullptr;
73  }
74  return static_pointer_cast<T>(it->second);
75 }
76 
77 template<typename T>
78 void
79 TagHost::setTag(shared_ptr<T> tag) const
80 {
81  static_assert(std::is_base_of<Tag, T>::value, "T must inherit from Tag");
82 
83  if (tag == nullptr) {
84  m_tags.erase(T::getTypeId());
85  }
86  else {
87  m_tags[T::getTypeId()] = std::move(tag);
88  }
89 }
90 
91 template<typename T>
92 void
94 {
95  setTag<T>(nullptr);
96 }
97 
98 } // namespace ndn
99 
100 #endif // NDN_CXX_DETAIL_TAG_HOST_HPP
void setTag(shared_ptr< T > tag) const
set a tag item
Definition: tag-host.hpp:79
Copyright (c) 2011-2015 Regents of the University of California.
shared_ptr< T > getTag() const
get a tag item
Definition: tag-host.hpp:66
void removeTag() const
remove tag item
Definition: tag-host.hpp:93
Base class to store tag information (e.g., inside Interest and Data packets)
Definition: tag-host.hpp:34
Common includes and macros used throughout the library.