NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
tag.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 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_TAG_HPP
23 #define NDN_TAG_HPP
24 
25 namespace ndn {
26 
30 class Tag
31 {
32 public:
33  virtual
34  ~Tag();
35 
41 #ifdef DOXYGEN
42  static constexpr int
43  getTypeId() noexcept
44  {
45  return <type-identifier>;
46  }
47 #endif // DOXYGEN
48 };
49 
50 inline
51 Tag::~Tag() = default;
52 
57 template<typename T, int TypeId>
58 class SimpleTag : public Tag
59 {
60 public:
61  static constexpr int
62  getTypeId() noexcept
63  {
64  return TypeId;
65  }
66 
69  constexpr explicit
70  SimpleTag(const T& value) noexcept
71  : m_value(value)
72  {
73  }
74 
78  operator T() const
79  {
80  return m_value;
81  }
82 
85  constexpr const T&
86  get() const noexcept
87  {
88  return m_value;
89  }
90 
91 private:
92  T m_value;
93 };
94 
95 } // namespace ndn
96 
97 #endif // NDN_TAG_HPP
ndn::Tag
Base class for packet tags that can hold any arbitrary information.
Definition: tag.hpp:31
ndn::SimpleTag::getTypeId
static constexpr int getTypeId() noexcept
Definition: tag.hpp:62
ndn::SimpleTag
provides a tag type for simple types
Definition: tag.hpp:59
ndn::Tag::~Tag
virtual ~Tag()
ndn::SimpleTag::get
constexpr const T & get() const noexcept
Definition: tag.hpp:86
ndn::Tag::getTypeId
static constexpr int getTypeId() noexcept
Definition: tag.hpp:43
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34
ndn::SimpleTag::SimpleTag
constexpr SimpleTag(const T &value) noexcept
explicitly convertible from T
Definition: tag.hpp:70