include/anna/comm/Variable.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_comm_Variable_hpp
  38 #define anna_comm_Variable_hpp
  39
  40 #include <anna/core/util/Variable.hpp>
  41 #include <anna/core/DataBlock.hpp>
  42
  43 #include <anna/comm/functions.hpp>
  44
  45 namespace anna {
  46
  47 namespace comm {
  48
  49 class CompatCodec;
  50
  51 /**
  52    Clase para guardar la informacion asociada a un anna::comm::Codec.
  53
  54    \warning Esta clase no establece proteccion ante accesos concurrentes
  55 */
  56 class Variable : public anna::Variable {
  57 public:
  58   /**
  59      Constructor para inicializar una instancia de tipo cadena.
  60     \param id Identificador logico de esta variable
  61     @param name Nombre logico que recibe este variable.
  62     @param value Referencia a la variable que estamos recubriendo con esta instancia.
  63   */
  64   Variable(const short int id, const char* name, std::string& value) :
  65     anna::Variable(name, value),
  66     a_id(id), a_precode(true) {;}
  67
  68   /**
  69   * Constructor para inicializar una instancia de type ENTERO.
  70   *
  71     \param id Identificador logico de esta variable
  72   * @param name Nombre logico que recibe este variable.
  73   * @param value Referencia a la variable que estamos recubriendo con esta instancia.
  74   */
  75   Variable(const short int id, const char* name, int& value) :
  76     anna::Variable(name, value),
  77     a_id(id), a_precode(true) {;}
  78
  79   /**
  80   * Constructor para inicializar una instancia de type ENTERO_LARGO.
  81   *
  82     \param id Identificador logico de esta variable
  83   * @param name Nombre logico que recibe este variable.
  84   * @param value Referencia a la variable que estamos recubriendo con esta instancia.
  85   */
  86   Variable(const short int id, const char* name, Integer64& value) :
  87     anna::Variable(name, value),
  88     a_id(id), a_precode(true) {;}
  89
  90   /**
  91   * Constructor para inicializar una instancia de type BOOLEAN.
  92   *
  93     \param id Identificador logico de esta variable
  94   * @param name Nombre logico que recibe este variable.
  95   * @param value Referencia a la variable que estamos recubriendo con esta instancia.
  96   */
  97   Variable(const short int id, const char* name, bool& value) :
  98     anna::Variable(name, value),
  99     a_id(id), a_precode(true) {;}
 100
 101   /**
 102   * Constructor para inicializar una instancia de type BLOQUE_MEMORIA.
 103   *
 104     \param id Identificador logico de esta variable
 105   * @param name Nombre logico que recibe este variable.
 106   * @param value Referencia a la variable que estamos recubriendo con esta instancia.
 107   */
 108   Variable(const short int id, const char* name, DataBlock& value) :
 109     anna::Variable(name, value),
 110     a_id(id), a_precode(true) {;}
 111
 112   /**
 113   * Constructor para inicializar una instancia de tipo float.
 114   *
 115     \param id Identificador logico de esta variable
 116   * @param name Nombre logico que recibe este variable.
 117   * @param value Referencia a la variable que estamos recubriendo con esta instancia.
 118   */
 119   Variable(const short int id, const char* name, float& value) :
 120     anna::Variable(name, value),
 121     a_id(id), a_precode(true) {;}
 122
 123   /**
 124   * Constructor para inicializar una instancia de tipo float.
 125   *
 126     \param id Identificador logico de esta variable
 127   * @param name Nombre logico que recibe este variable.
 128   * @param value Referencia a la variable que estamos recubriendo con esta instancia.
 129   */
 130   Variable(const short int id, const char* name, double& value) :
 131     anna::Variable(name, value),
 132     a_id(id), a_precode(true) {;}
 133
 134   /**
 135   * Constructor para inicializar una instancia de tipo float.
 136   *
 137     \param id Identificador logico de esta variable
 138   * @param name Nombre logico que recibe este variable.
 139   * @param value Referencia a la variable que estamos recubriendo con esta instancia.
 140   */
 141   Variable(const short int id, const char* name, comm::CompatCodec& value) :
 142     anna::Variable(name, (void*) &value),
 143     a_id(id), a_precode(true) {;}
 144
 145   /**
 146      Devuelve el identificador logico de esta variable.
 147      \return el identificador logico de esta variable.
 148   */
 149   short int getId() const throw() { return a_id; }
 150
 151 private:
 152   const short int a_id;
 153   DataBlock a_precode;
 154
 155   const DataBlock& codec() const throw(RuntimeException) {
 156     return (a_precode.isEmpty() == false) ? a_precode : precodec();
 157   }
 158   const DataBlock& precodec() const throw(RuntimeException) {
 159     char aux [sizeof(short int)];
 160     const_cast <comm::Variable*>(this)->a_precode.append(comm::functions::codeShort(aux, a_id), sizeof(short int));
 161     const_cast <comm::Variable*>(this)->a_precode += (char) getType();
 162     return a_precode;
 163   }
 164
 165   friend class CompatCodec;
 166 };
 167
 168 }
 169
 170 }
 171
 172 #endif
 173