1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_comm_Variable_hpp
38 #define anna_comm_Variable_hpp
40 #include <anna/core/util/Variable.hpp>
41 #include <anna/core/DataBlock.hpp>
43 #include <anna/comm/functions.hpp>
52 Clase para guardar la informacion asociada a un anna::comm::Codec.
54 \warning Esta clase no establece proteccion ante accesos concurrentes
56 class Variable : public anna::Variable {
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.
64 Variable(const short int id, const char* name, std::string& value) :
65 anna::Variable(name, value),
66 a_id(id), a_precode(true) {;}
69 * Constructor para inicializar una instancia de type ENTERO.
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.
75 Variable(const short int id, const char* name, int& value) :
76 anna::Variable(name, value),
77 a_id(id), a_precode(true) {;}
80 * Constructor para inicializar una instancia de type ENTERO_LARGO.
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.
86 Variable(const short int id, const char* name, S64& value) :
87 anna::Variable(name, value),
88 a_id(id), a_precode(true) {;}
91 * Constructor para inicializar una instancia de type BOOLEAN.
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.
97 Variable(const short int id, const char* name, bool& value) :
98 anna::Variable(name, value),
99 a_id(id), a_precode(true) {;}
102 * Constructor para inicializar una instancia de type BLOQUE_MEMORIA.
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.
108 Variable(const short int id, const char* name, DataBlock& value) :
109 anna::Variable(name, value),
110 a_id(id), a_precode(true) {;}
113 * Constructor para inicializar una instancia de tipo float.
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.
119 Variable(const short int id, const char* name, float& value) :
120 anna::Variable(name, value),
121 a_id(id), a_precode(true) {;}
124 * Constructor para inicializar una instancia de tipo float.
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.
130 Variable(const short int id, const char* name, double& value) :
131 anna::Variable(name, value),
132 a_id(id), a_precode(true) {;}
135 * Constructor para inicializar una instancia de tipo float.
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.
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) {;}
146 Devuelve el identificador logico de esta variable.
147 \return el identificador logico de esta variable.
149 short int getId() const throw() { return a_id; }
152 const short int a_id;
155 const DataBlock& codec() const throw(RuntimeException) {
156 return (a_precode.isEmpty() == false) ? a_precode : precodec();
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();
165 friend class CompatCodec;