Updated license
[anna.git] / include / anna / diameter / codec / basetypes / Unsigned32.hpp
1 // ANNA - Anna is Not Nothingness Anymore
2 //
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
4 //
5 // https://bitbucket.org/testillano/anna
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
9 // are met:
10 //
11 //     * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 //     * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 //     * Neither the name of Google Inc. nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 // Authors: eduardo.ramos.testillano@gmail.com
34 //          cisco.tierra@gmail.com
35
36
37 #ifndef anna_diameter_codec_basetypes_Unsigned32_hpp
38 #define anna_diameter_codec_basetypes_Unsigned32_hpp
39
40
41 // Local
42 #include <anna/diameter/codec/basetypes/AvpData.hpp>
43
44 #include <anna/config/defines.hpp>
45
46
47 namespace anna {
48
49 namespace diameter {
50
51 namespace codec {
52
53 class Avp;
54
55 namespace basetypes {
56
57 /**
58 * Diameter Unsigned32 container
59 */
60 class Unsigned32 : public AvpData {
61
62   U32 a_value;
63
64
65   // Mandatory for basic diameter type:
66   void codeBasic(char* buffer, int &size) throw(anna::RuntimeException);
67   void setPrintableString(const char * printableString) throw(anna::RuntimeException);
68
69 public:
70
71
72   // Class-specific ////////////////////////////////////////////////////////////////////////////////////
73   //
74   /**
75   * Gets the Unsigned32 value
76   *
77   * @return Unsigned32 value
78   */
79   const U32& getValue() const throw() { return a_value; }
80
81   /**
82   * Sets the Unsigned32 value
83   *
84   * @param value Unsigned32 value
85   */
86   void setValue(const U32& value) throw() { a_value = value; }
87   //
88   //////////////////////////////////////////////////////////////////////////////////////////////////////
89
90
91   // gets
92
93   virtual std::string getFormatName() const throw() { return "Unsigned32"; }
94   virtual int getSize() const throw() { return 4; }
95
96
97   // helpers
98
99   std::string asPrintableString() throw(anna::RuntimeException) {
100     return anna::functions::asString(a_value);
101   }
102
103   std::string asString() throw(anna::RuntimeException) {
104     return asPrintableString();
105   }
106
107
108   // sets
109
110   void decode(const char* buffer, const int size) throw(anna::RuntimeException);
111 };
112
113 }
114 }
115 }
116 }
117
118 #endif