include/anna/diameter/stack/Vendor.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_stack_Vendor_hpp
  38 #define anna_diameter_stack_Vendor_hpp
  39
  40 // Local
  41 #include <anna/config/defines.hpp>
  42 #include <anna/diameter/defines.hpp>
  43
  44 #include <anna/config/defines.hpp>
  45 #include <anna/core/RuntimeException.hpp>
  46 #include <anna/core/define.autoenum.hpp>
  47
  48 // STL
  49 #include <string>
  50
  51
  52
  53 namespace anna {
  54 namespace xml {
  55 class Node;
  56 }
  57 }
  58
  59
  60
  61 namespace anna {
  62
  63 namespace diameter {
  64
  65 namespace stack {
  66
  67
  68 //------------------------------------------------------------------------------
  69 //----------------------------------------------------------------- class Vendor
  70 //------------------------------------------------------------------------------
  71 /**
  72 * Vendor data container
  73 */
  74 class Vendor {
  75   S32 a_id;
  76   std::string a_name;
  77
  78 public:
  79
  80   struct Code {
  81     enum _v {
  82       None = -1, // Initialized
  83       Ietf = 0,
  84       Nokia = 94,
  85       Ericsson = 193,
  86       TresGPP = 10415,
  87       Telefonicaid = 5189,
  88       Etsi = 13019
  89     };
  90
  91     anna_declare_enum(Code);
  92
  93     /**
  94     * Vendor description
  95     * @param v Vendor code
  96     * @return Vendor name
  97     */
  98     static const char* asText(const Code::_v v) throw(anna::RuntimeException) {
  99       return asCString(v);
 100     }
 101   };
 102
 103
 104   Vendor() {};
 105   ~Vendor() {};
 106
 107
 108   // get
 109   S32 getId(void) const throw() { return a_id; }
 110   const S8 * getName(void) const throw() { return a_name.c_str(); }
 111
 112   // helpers
 113   bool isVendorSpecific(void) const throw() { return (a_id > 0); }
 114
 115
 116   std::string asString(void) const throw();
 117   anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
 118
 119   // operators
 120   friend bool operator == (const Vendor & v1, const Vendor & v2) { return ((v1.getId() == v2.getId())); }
 121
 122   // set
 123   void setId(const S32 & id) throw(anna::RuntimeException) {
 124     if(id < 0) throw anna::RuntimeException("Negative vendor-id not allowed", ANNA_FILE_LOCATION);
 125
 126     a_id = id;
 127   }
 128
 129   void setName(const std::string & n) throw(anna::RuntimeException) {
 130     if(n == "") throw anna::RuntimeException("Empty vendor-name string not allowed", ANNA_FILE_LOCATION);
 131
 132     a_name = n;
 133   }
 134 };
 135
 136
 137 }
 138 }
 139 }
 140
 141
 142 #endif