blob: 1a2db36af564db68eccd10211586550ca7c8f5a2 [file] [log] [blame]
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento3b101d02018-07-21 22:44:09 -04002/*
3 * Copyright (c) 2013-2018 Regents of the University of California.
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -08004 *
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
25namespace ndn {
26
27/**
Junxiao Shi4b469982015-12-03 18:20:19 +000028 * @brief Base class for packet tags that can hold any arbitrary information
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -080029 */
30class Tag
31{
32public:
33 virtual
Junxiao Shi4b469982015-12-03 18:20:19 +000034 ~Tag();
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -080035
36 /**
Davide Pesavento3b101d02018-07-21 22:44:09 -040037 * @fn static constexpr int getTypeId() noexcept
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -080038 * @return an integer that uniquely identifies this Tag type
Davide Pesavento3b101d02018-07-21 22:44:09 -040039 * @sa https://redmine.named-data.net/projects/ndn-cxx/wiki/PacketTagTypes
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -080040 */
Alexander Afanasyevf2a46222015-09-17 18:01:30 -070041#ifdef DOXYGEN
42 static constexpr int
Davide Pesavento3b101d02018-07-21 22:44:09 -040043 getTypeId() noexcept
Alexander Afanasyevf2a46222015-09-17 18:01:30 -070044 {
45 return <type-identifier>;
46 }
47#endif // DOXYGEN
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -080048};
49
50inline
Junxiao Shi4b469982015-12-03 18:20:19 +000051Tag::~Tag() = default;
52
53/** @brief provides a tag type for simple types
54 * @tparam T the value type
55 * @tparam TypeId the TypeId
56 */
57template<typename T, int TypeId>
58class SimpleTag : public Tag
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -080059{
Junxiao Shi4b469982015-12-03 18:20:19 +000060public:
61 static constexpr int
Davide Pesavento3b101d02018-07-21 22:44:09 -040062 getTypeId() noexcept
Junxiao Shi4b469982015-12-03 18:20:19 +000063 {
64 return TypeId;
65 }
66
67 /** \brief explicitly convertible from T
68 */
Davide Pesavento3b101d02018-07-21 22:44:09 -040069 constexpr explicit
70 SimpleTag(const T& value) noexcept
Junxiao Shi4b469982015-12-03 18:20:19 +000071 : m_value(value)
72 {
73 }
74
75 /** \brief implicitly convertible to T
76 * \return a copy of the enclosed value
77 */
78 operator T() const
79 {
80 return m_value;
81 }
82
83 /** \return the enclosed value
84 */
Davide Pesavento3b101d02018-07-21 22:44:09 -040085 constexpr const T&
86 get() const noexcept
Junxiao Shi4b469982015-12-03 18:20:19 +000087 {
88 return m_value;
89 }
90
91private:
92 T m_value;
93};
Alexander Afanasyeva3887ae2014-12-29 16:11:57 -080094
95} // namespace ndn
96
97#endif // NDN_TAG_HPP