Qpid Proton C++ API  0.38.0
scalar.hpp
Go to the documentation of this file.
1 #ifndef PROTON_SCALAR_HPP
2 #define PROTON_SCALAR_HPP
3 
4 /*
5  * Licensed to the Apache Software Foundation (ASF) under one
6  * or more contributor license agreements. See the NOTICE file
7  * distributed with this work for additional information
8  * regarding copyright ownership. The ASF licenses this file
9  * to you under the Apache License, Version 2.0 (the
10  * "License"); you may not use this file except in compliance
11  * with the License. You may obtain a copy of the License at
12  *
13  * http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing,
16  * software distributed under the License is distributed on an
17  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18  * KIND, either express or implied. See the License for the
19  * specific language governing permissions and limitations
20  * under the License.
21  */
22 
23 #include "./scalar_base.hpp"
24 
25 #include "proton/null.hpp"
26 
27 #include <proton/type_compat.h>
28 
31 
32 namespace proton {
33 
37 class scalar : public scalar_base {
38  public:
40  PN_CPP_EXTERN scalar() = default;
41 
43  template <class T> scalar(const T& x) { *this = x; }
44 
46  template <class T> scalar& operator=(const T& x) { put(x); return *this; }
47 
49  void clear() { *this = null(); }
50 };
51 
60 template<class T> T get(const scalar& s) { return internal::get<T>(s); }
61 
72 template<class T> T coerce(const scalar& x) { return internal::coerce<T>(x); }
73 
74 
85 template<class T> T coerce(scalar& x) { return internal::coerce<T>(x); }
86 
87 } // proton
88 
89 #endif // PROTON_SCALAR_HPP
The base class for scalar types.
Definition: scalar_base.hpp:60
A holder for an instance of any scalar AMQP type.
Definition: scalar.hpp:37
scalar(const T &x)
Construct from any scalar type.
Definition: scalar.hpp:43
T coerce(scalar &x)
Coerce the contained value to type T.
Definition: scalar.hpp:85
T coerce(const scalar &x)
Coerce the contained value to type T.
Definition: scalar.hpp:72
T get(const scalar &s)
Get a contained value of type T.
Definition: scalar.hpp:60
scalar & operator=(const T &x)
Assign from any scalar type.
Definition: scalar.hpp:46
scalar()=default
Create an empty scalar.
void clear()
Clear the scalar, making it empty().
Definition: scalar.hpp:49
The main Proton namespace.
Definition: annotation_key.hpp:33
The type of the AMQP null value.
The base class for scalar types.