PCL
KeyValue.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/KeyValue.h - Released 2024-06-18T15:48:54Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_KeyValue_h
53 #define __PCL_KeyValue_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/String.h>
60 
61 namespace pcl
62 {
63 
64 // ----------------------------------------------------------------------------
65 
70 template <typename T1, typename T2>
71 class PCL_CLASS KeyValue
72 {
73 public:
74 
75  T1 key;
76  T2 value;
77 
82  : key()
83  , value()
84  {
85  }
86 
90  KeyValue( const T1& k, const T2& v )
91  : key( k )
92  , value( v )
93  {
94  }
95 
100  KeyValue( const T1& k )
101  : key( k )
102  , value()
103  {
104  }
105 
109  KeyValue( const KeyValue& ) = default;
110 
114  KeyValue( KeyValue&& ) = default;
115 
119  KeyValue& operator =( const KeyValue& ) = default;
120 
124  KeyValue& operator =( KeyValue&& ) = default;
125 
131  bool operator ==( const KeyValue& x ) const
132  {
133  return key == x.key && value == x.value;
134  }
135 
151  bool operator <( const KeyValue& x ) const
152  {
153  return (key < x.key) ? true : ((x.key < key) ? false : value < x.value);
154  }
155 };
156 
157 // ----------------------------------------------------------------------------
158 
168 using StringKeyValue = KeyValue<String, String>;
169 
175 using IsoStringKeyValue = KeyValue<IsoString, IsoString>;
176 
177 // ----------------------------------------------------------------------------
178 
179 } // pcl
180 
181 #endif // __PCL_KeyValue_h
182 
183 // ----------------------------------------------------------------------------
184 // EOF pcl/KeyValue.h - Released 2024-06-18T15:48:54Z
Key-value association of two 8-bit strings.
Generic key-value association.
Definition: KeyValue.h:72
T2 value
The value member of this key-value association.
Definition: KeyValue.h:76
KeyValue(KeyValue &&)=default
T1 key
The key member of this key-value association.
Definition: KeyValue.h:75
KeyValue(const T1 &k, const T2 &v)
Definition: KeyValue.h:90
KeyValue(const KeyValue &)=default
KeyValue(const T1 &k)
Definition: KeyValue.h:100
Key-value association of two Unicode (UTF-16) strings.
bool operator==(const Array< T, A > &x1, const Array< T, A > &x2) noexcept
Definition: Array.h:2267
bool operator<(const Array< T, A > &x1, const Array< T, A > &x2) noexcept
Definition: Array.h:2278
PCL root namespace.
Definition: AbstractImage.h:77