First commit
[anna.git] / include / anna / diameter / helpers / tme / codectypes / ISDNNumber.hpp
1 // ANNA - Anna is Not 'N' 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_helpers_tme_codectypes_ISDNNumber_hpp
38 #define anna_diameter_helpers_tme_codectypes_ISDNNumber_hpp
39
40
41 // Local
42 #include <anna/diameter/codec/basetypes/OctetString.hpp>
43
44 #include <anna/config/defines.hpp> // isup_number_t
45
46
47 namespace anna {
48
49 namespace diameter {
50
51 namespace codec {
52 class Avp;
53 }
54
55 namespace helpers {
56
57 namespace tme {
58
59 namespace codectypes {
60
61 /**
62 * Diameter ISDNNumber container
63   Internal format is based in Calling Party Number (Q763)
64 */
65 class ISDNNumber : public codec::basetypes::OctetString {
66
67   isup_number_t a_isupNumber;
68
69   // Only for derived diameter type:
70   void updateBasic() throw(anna::RuntimeException);
71
72 public:
73
74   // Class-specific ////////////////////////////////////////////////////////////////////////////////////
75   //
76   /**
77   * Gets the Q763 ISUP Number
78   *
79   * @return Q763 ISUP Number
80   */
81   const isup_number_t& getIsupNumber() const throw() { return a_isupNumber; }
82
83   /**
84   * Sets the Q763 ISUP Number
85   *
86   * @param isupNumber Q763 ISUP Number
87   */
88   void setIsupNumber(const isup_number_t& isupNumber) throw() { a_isupNumber = isupNumber; updateBasic(); }
89   //
90   //////////////////////////////////////////////////////////////////////////////////////////////////////
91
92   // gets
93
94   std::string getFormatName() const throw() { return "ISDNNumber"; }
95
96   // helpers
97
98   std::string asString() throw(anna::RuntimeException) {
99     return a_isupNumber.asString(false /* calling party number */);
100   }
101
102
103   // sets
104
105   void decode(const char* buffer, const int size) throw(anna::RuntimeException);
106
107
108   // exports /////////////////////////////
109   using AvpData::getSize;
110   using AvpData::code;
111   //using OctetString::asPrintableString;
112   using AvpData::asDataBlockString;
113   //using OctetString::asString;
114   using AvpData::asHexString;
115   //using OctetString::decode;
116   using AvpData::fromPrintableString;
117   using AvpData::fromHexString;
118
119 };
120
121 }
122 }
123 }
124 }
125 }
126
127 #endif
128