anna::Variable Class Reference

#include <Variable.hpp>

Inheritance diagram for anna::Variable:

Collaboration diagram for anna::Variable:

Classes
struct	Type

Public Member Functions
	Variable (const char *name, std::string &value)
	Variable (const char *name, int &value)
	Variable (const char *name, S64 &value)
	Variable (const char *name, bool &value)
	Variable (const char *name, DataBlock &value)
	Variable (const char *name, float &value)
	Variable (const char *name, double &value)
	Variable (const char *name, void *value)
	Variable (const char *name, const Type::_v type)
virtual	~Variable ()
Type::_v	getType () const
const char *	getName () const
bool	isNull () const
const char *	getStringValue () const noexcept(false)
int	getIntegerValue () const noexcept(false)
S64	getInteger64Value () const noexcept(false)
bool	getBooleanValue () const noexcept(false)
const DataBlock &	getDataBlockValue () const noexcept(false)
float	getFloatValue () const noexcept(false)
double	getDoubleValue () const noexcept(false)
void *	getCustom () noexcept(false)
const void *	getCustom () const noexcept(false)
void	setCustom (void *value) noexcept(false)
int	getInteger () const
S64	getInteger64 () const
bool	getBoolean () const
const DataBlock &	getDataBlock () const
float	getFloat () const
double	getDouble () const
void	setValue (const char *value) noexcept(false)
void	setCharPointer (const char *value) noexcept(false)
void	setValue (const int value) noexcept(false)
void	setValue (const S64 value) noexcept(false)
void	setValue (const bool value) noexcept(false)
void	setValue (const DataBlock &value) noexcept(false)
void	setValue (const float value) noexcept(false)
void	setValue (const double value) noexcept(false)
void	setNull (const bool isNull=true)
void	setInteger (const int value)
void	setLong (const S64 value)
void	setBoolean (const bool value)
void	setDataBlock (const DataBlock &value)
void	setFloat (const float value)
void	setDouble (const double value)
bool	isEqual (const Variable &right) const
virtual String	asString () const

Protected Member Functions
void *	getReference () const
void *	buffer () const
bool *	getNullIndicator ()

Detailed Description

Recubrimiento de variables de usuario.

Establece un recubrimiento sobre los tipos de variables soportados por el nucleo

Constructor & Destructor Documentation

Variable() [1/9]

anna::Variable::Variable ( const char *  name, std::string &  value  )

inline

Constructor para inicializar una instancia de tipo cadena.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                               :
    a_name(name),
    a_isNull(false),
    a_type(Type::String),
    a_isOwner(false) {
    a_value.a_string = &value;
  }

Variable() [2/9]

anna::Variable::Variable ( const char *  name, int &  value  )

inline

Constructor para inicializar una instancia de type entero.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                         :
    a_name(name),
    a_isNull(false),
    a_type(Type::Integer),
    a_isOwner(false) {
    value = 0;
    a_value.a_integer = &value;
  }

Variable() [3/9]

anna::Variable::Variable ( const char *  name, S64 &  value  )

inline

Constructor para inicializar una instancia de type long.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                         :
    a_name(name),
    a_isNull(false),
    a_type(Type::Integer64),
    a_isOwner(false) {
    value = 0;
    a_value.a_longInteger = &value;
  }

Variable() [4/9]

anna::Variable::Variable ( const char *  name, bool &  value  )

inline

Constructor para inicializar una instancia de type BOOLEAN.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                          :
    a_name(name),
    a_isNull(false),
    a_type(Type::Boolean),
    a_isOwner(false) {
    value = false;
    a_value.a_boolean = &value;
  }

Variable() [5/9]

anna::Variable::Variable ( const char *  name, DataBlock &  value  )

inline

Constructor para inicializar una instancia de type BLOQUE_MEMORIA.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                               :
    a_name(name),
    a_isNull(false),
    a_type(Type::Block),
    a_isOwner(false) {
    a_value.a_dataBlock = &value;
  }

Variable() [6/9]

anna::Variable::Variable ( const char *  name, float &  value  )

inline

Constructor para inicializar una instancia de type float.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                           :
    a_name(name),
    a_isNull(false),
    a_type(Type::Float),
    a_isOwner(false) {
    value = 0;
    a_value.a_float = &value;
  }

Variable() [7/9]

anna::Variable::Variable ( const char *  name, double &  value  )

inline

Constructor para inicializar una instancia de type double.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                            :
    a_name(name),
    a_isNull(false),
    a_type(Type::Double),
    a_isOwner(false) {
    value = 0;
    a_value.a_double = &value;
  }

Variable() [8/9]

anna::Variable::Variable ( const char *  name, void *  value  )

inline

Constructor para inicializar una instancia de un tipo definido por el usuario.

Parameters

name	Nombre logico que recibe este variable.
value	Referencia a la variable que estamos recubriendo con esta instancia.

                                          :
    a_name(name),
    a_isNull(false),
    a_type(Type::Custom),
    a_isOwner(false) {
    a_value.a_custom = value;
  }

Here is the call graph for this function:

Variable() [9/9]

anna::Variable::Variable	(	const char *	name,
		const Type::_v	type
	)

Constructor.

Parameters

name	Nombre logico que recibe esta variable.
type	Tipo de dato de esta variable.

~Variable()

virtual anna::Variable::~Variable ( )

virtual

Destructor

Member Function Documentation

asString()

virtual String anna::Variable::asString ( ) const

virtual

Devuelve una cadena con informacion relevante de esta instancia.

Returns

Una cadena con informacion relevante de esta instancia.

buffer()

void* anna::Variable::buffer ( ) const

protected

Devuelve el area de memoria de la variable C++ a sociada a esta variable logica.

Returns

La area de memoria de la variable C++ a sociada a esta variable logica.

Warning

La forma de interpretar este valor dependera del tipo de dato (ver #Type) asociado a esta variable.

getBoolean()

bool anna::Variable::getBoolean ( ) const

inline

Interpreta el valor asociado a esta variable como un valor booleano.

Warning

No se realiza ninguna comprobacion semantica.

{ return *a_value.a_boolean; }

getBooleanValue()

bool anna::Variable::getBooleanValue ( ) const

noexcept

Devuelve el valor booleano asociado a esta variable.

Returns

Si la variable indicada en el contructor de esta instancia puede interpretarse como un booleano y este es distinto de cero devolvera true en otro caso devolvera false. indicar el error.

getCustom() [1/2]

void* anna::Variable::getCustom ( )

inlinenoexcept

Devuelve el valor de un elemento definido por el usuario.

                                    {
    verifyMatchType(Type::Custom, ANNA_FILE_LOCATION);
    return a_value.a_custom;
  }

getCustom() [2/2]

const void* anna::Variable::getCustom ( ) const

inlinenoexcept

Devuelve el valor de un elemento definido por el usuario.

                                                {
    verifyMatchType(Type::Custom, ANNA_FILE_LOCATION);
    return a_value.a_custom;
  }

getDataBlock()

const DataBlock& anna::Variable::getDataBlock ( ) const

inline

Interpreta el valor asociado a esta variable como un valor bloque de datos.

Warning

No se realiza ninguna comprobacion semantica.

{ return *a_value.a_dataBlock; }

getDataBlockValue()

const DataBlock& anna::Variable::getDataBlockValue ( ) const

noexcept

Devuelve el bloque de memoria asociado a esta variable.

Returns

Si la variable indicada en el contructor de esta instancia era de type DataBlock devolvera el contenido de esta, en otro caso lanzara una excepcion.

getDouble()

double anna::Variable::getDouble ( ) const

inline

Interpreta el valor asociado a esta variable como un valor en coma flotante de 64 bits

Warning

No se realiza ninguna comprobacion semantica.

{ return *a_value.a_double; }

Here is the call graph for this function:

getDoubleValue()

double anna::Variable::getDoubleValue ( ) const

noexcept

Devuelve el valor numerico asociado a esta variable.

Returns

Si la variable indicada en el contructor de esta instancia puede interpretarse como un entero en coma flotante devolvera su contenido, en otro caso lanzara una excepcion para indicar el error.

getFloat()

float anna::Variable::getFloat ( ) const

inline

Interpreta el valor asociado a esta variable como un valor en coma flotante de 32 bits

Warning

No se realiza ninguna comprobacion semantica.

{ return *a_value.a_float; }

getFloatValue()

float anna::Variable::getFloatValue ( ) const

noexcept

Devuelve el valor numerico asociado a esta variable.

Returns

Si la variable indicada en el contructor de esta instancia puede interpretarse como un entero en coma flotante devolvera su contenido, en otro caso lanzara una excepcion para indicar el error.

getInteger()

int anna::Variable::getInteger ( ) const

inline

Interpreta el valor asociado a esta variable como un valor entero.

Warning

No se realiza ninguna comprobacion semantica.

{ return *a_value.a_integer; }

getInteger64()

S64 anna::Variable::getInteger64 ( ) const

inline

Interpreta el valor asociado a esta variable como un valor entero largo.

Warning

No se realiza ninguna comprobacion semantica.

{ return *a_value.a_longInteger; }

getInteger64Value()

S64 anna::Variable::getInteger64Value ( ) const

noexcept

Devuelve el valor numerico asociado a esta variable.

Returns

Si la variable indicada en el contructor de esta instancia puede interpretarse como un entero de 64 bits devolvera su contenido, en otro caso lanzara una excepcion para indicar el error.

getIntegerValue()

int anna::Variable::getIntegerValue ( ) const

noexcept

Devuelve el valor numerico asociado a esta variable.

Returns

Si la variable indicada en el contructor de esta instancia puede interpretarse como un entero de 32 bits devolvera su contenido, en otro caso lanzara una excepcion para indicar el error.

getName()

const char* anna::Variable::getName ( ) const

inline

Devuelve el nombre logico asociado a esta variable.

Returns

Nombre logico asociado a esta variable.

{ return a_name.c_str(); }

getNullIndicator()

bool* anna::Variable::getNullIndicator ( )

inlineprotected

Devuelve la referencia a la variable que controla el indicador de nulo de esta variable.

Returns

La referencia a la variable que controla el indicador de nulo de esta variable.

{ return &a_isNull; }

getReference()

void* anna::Variable::getReference ( ) const

protected

Devuelve la direccion de memoria de la variable C++ a sociada a esta variable logica.

Returns

La direccion de memoria de la variable C++ a sociada a esta variable logica.

Warning

La forma de interpretar este valor dependera del tipo de dato (ver #Type) asociado Devuelve la referencia a memoria de esta variable.

getStringValue()

const char* anna::Variable::getStringValue ( ) const

noexcept

Devuelve el valor alfabetico asociado a esta variable.

Returns

Si la variable indicada en el contructor de esta instancia puede interpretarse como una string devolvera su contenido, en otro caso lanzara una excepcion para indicar el error.

getType()

Type::_v anna::Variable::getType ( ) const

inline

Devuelve el tipo del dato al que recubre esta variable.

Returns

El tipo del dato al que recubre esta variable.

{ return a_type; }

isEqual()

bool anna::Variable::isEqual ( const Variable &  right ) const

inline

Returns

true si la variable recibida tiene el mismo nombre que esta instancia o false en otro caso.

{ return a_name == right.a_name; }

Here is the call graph for this function:

isNull()

bool anna::Variable::isNull ( ) const

inline

Devuelve false si esta marcado como nulo o true en otro caso.

Returns

false si esta marcado como nulo o true en otro caso.

{ return a_isNull; }

Here is the call graph for this function:

setBoolean()

void anna::Variable::setBoolean ( const bool  value )

inline

Establece el valor asociado a esta variable como un valor booleano.

Warning

No se realiza ninguna comprobacion semantica.

{ *a_value.a_boolean = value; a_isNull = false; }

setCharPointer()

void anna::Variable::setCharPointer ( const char *  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

setCustom()

void anna::Variable::setCustom ( void *  value )

inlinenoexcept

Devuelve el valor de un elemento definido por el usuario.

                                              {
    verifyMatchType(Type::Custom, ANNA_FILE_LOCATION);
    a_isNull = (value == NULL);
    a_value.a_custom = value;
  }

setDataBlock()

void anna::Variable::setDataBlock ( const DataBlock &  value )

inline

Interpreta el valor asociado a esta variable como un valor bloque de datos.

Warning

No se realiza ninguna comprobacion semantica.

{ *a_value.a_dataBlock = value; a_isNull = false; }

setDouble()

void anna::Variable::setDouble ( const double  value )

inline

Interpreta el valor asociado a esta variable como número en coma flotante.

Warning

No se realiza ninguna comprobacion semantica.

{ *a_value.a_double = value; a_isNull = false; }

setFloat()

void anna::Variable::setFloat ( const float  value )

inline

Interpreta el valor asociado a esta variable como número en coma flotante.

Warning

No se realiza ninguna comprobacion semantica.

{ *a_value.a_float = value; a_isNull = false; }

setInteger()

void anna::Variable::setInteger ( const int  value )

inline

Establece el valor asociado a esta variable como un valor entero.

Warning

No se realiza ninguna comprobacion semantica.

{ *a_value.a_integer = value; a_isNull = false; }

setLong()

void anna::Variable::setLong ( const S64  value )

inline

Establece el valor asociado a esta variable como un valor entero largo.

Warning

No se realiza ninguna comprobacion semantica.

{ *a_value.a_longInteger = value; a_isNull = false; }

setNull()

void anna::Variable::setNull ( const bool  isNull = true )

inline

Marca/Desmarca la variable como nula.

Parameters

isNull

Indica la nueva marca de la variable.

{ a_isNull = isNull; }

Here is the call graph for this function:

setValue() [1/7]

void anna::Variable::setValue ( const char *  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

setValue() [2/7]

void anna::Variable::setValue ( const int  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

setValue() [3/7]

void anna::Variable::setValue ( const S64  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

setValue() [4/7]

void anna::Variable::setValue ( const bool  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

setValue() [5/7]

void anna::Variable::setValue ( const DataBlock &  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

setValue() [6/7]

void anna::Variable::setValue ( const float  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

setValue() [7/7]

void anna::Variable::setValue ( const double  value )

noexcept

Establece el valor de la variable a la que recubre. Si la variable estaba marcada como nula la desmarca. Si el type de dato que deseamos establecer no coincide con el type de dato indicado al crear esta variable devolvera una excepcion de ejecucion indicado la anomalia.

Parameters

value

Valor que tomara la variable a la que recubre este variable.

Member Data Documentation

a_boolean

bool* anna::Variable::a_boolean

a_custom

void* anna::Variable::a_custom

a_dataBlock

DataBlock* anna::Variable::a_dataBlock

a_double

double* anna::Variable::a_double

a_float

float* anna::Variable::a_float

a_integer

int* anna::Variable::a_integer

a_longInteger

S64* anna::Variable::a_longInteger

a_string

std::string* anna::Variable::a_string

boolean

bool anna::Variable::boolean

integer

int anna::Variable::integer

longInteger

S64 anna::Variable::longInteger

theDouble

double anna::Variable::theDouble

theFloat

float anna::Variable::theFloat

---

The documentation for this class was generated from the following file:

• /tmp/anna/include/anna/core/util/Variable.hpp