source: observatorio/simulacion/SimEscenariosEconomicos/common.H

/*
  Copyright (C) 2012
  Alejandro Mujica (amujica@cenditel.gob.ve)
  Erwin Paredes (eparedes@cenditel.gob.ve)
  José Ruiz (jruiz@cenditel.gob.ve)
  Rodolfo Rangel (rrangel@cenditel.gob.ve)
  Julie Vera (jvera@cenditel.gob.ve)
 
  CENDITEL Fundación Centro Nacional de Desarrollo e Investigación en
  Tecnologías Libres
 
  Este programa es software libre; Usted puede usarlo bajo los términos de la
  licencia de software GPL versión 2.0 de la Free Software Foundation.
 
  Este programa se distribuye con la esperanza de que sea útil, pero SIN
  NINGUNA GARANTÍA; tampoco las implícitas garantías de MERCANTILIDAD o
  ADECUACIÓN A UN PROPÓSITO PARTICULAR.
  Consulte la licencia GPL para más detalles. Usted debe recibir una copia
  de la GPL junto con este programa; si no, escriba a la Free Software
  Foundation Inc. 51 Franklin Street,5 Piso, Boston, MA 02110-1301, USA.
*/

/*
  Autor:             Alejandro J. Mujica
  Fecha de creación: 22/07/2013
  Este archivo contiene definiciones de constantes, funciones y algunos tipos de
  datos utilitarios.
*/

# ifndef COMMON_H
# define COMMON_H

// Biblioteca estándar de C
# include <cstdlib>
# include <cmath>
# include <cstdarg>
# include <cassert>

// Biblioteca estándar de C++
# include <iostream>
# include <string>
# include <sstream>
# include <stdexcept>

// Biblioteca libxml++
# include <libxml++/libxml++.h>
# include <libxml++/parsers/textreader.h>
# include <libxml++/nodes/node.h>
# include <libxml++/document.h>
# include <libxml++/parsers/domparser.h>
# include <libxml++/keepblanks.h>

// Cabeceras propias
# include <types.H>
# include <productionNetwork.H>

/** Constantes de nombres de tablas y atributos de la base de datos.
 *
 *  Contiene todos los nombres de tablas y campos almacenados en constantes
 *  estáticas con el fin de evitar errores en los nombres al efectuar una
 *  consulta. Al éstos estar en constantes, si se escribe mal daría error de
 *  compilación y en el caso de uso de IDE's existe la opción de
 *  autocompletación.
 *
 * @author Alejandro J. Mujica
 */
struct DB {

    // Nombres de tablas
    static const std::string PRODUCT_TABLE_NAME;

    static const std::string INPUT_TABLE_NAME;

    static const std::string PLANT_TABLE_NAME;

    static const std::string COMPANY_TABLE_NAME;

    static const std::string COMPANY_ACTIVITY_CIIU_TABLE_NAME;

    static const std::string PRODUCT_INPUT_TABLE_NAME;

    static const std::string MEASUREMENT_UNIT_TABLE_NAME;

    static const std::string INPUT_SUPPLIER_TABLE_NAME;

    static const std::string SUPPLIER_TABLE_NAME;

    static const std::string PRODUCTION_QUANTITIES_TABLE_NAME;

    static const std::string ACQ_PRICE_TABLE_NAME;

    static const std::string COUNTRY_TABLE_NAME;

    static const std::string PARISH_TABLE_NAME;

    static const std::string TOWN_TABLE_NAME;

    static const std::string STATE_TABLE_NAME;

    static const std::string COMPANY_OCCUPANCY_TABLE_NAME;

    // Nombres de campos
    static const std::string ID;

    static const std::string NAME;

    static const std::string COMPANY_NAME;

    static const std::string TECHNICAL_SPECIFICATION;

    static const std::string TARIFF_CODE;

    static const std::string MEASUREMENT_UNIT_ID;

    static const std::string TRADEMARK;

    static const std::string PLANT_ID;

    static const std::string CODE;

    static const std::string PARISH_CODE;

    static const std::string TOWN_CODE;

    static const std::string STATE_CODE;

    static const std::string COMPANY_RIF;

    static const std::string UE_RIF;

    static const std::string RIF;

    static const std::string NATIONALITY;

    static const std::string ACQ_PRICE;

    static const std::string NAC_ACQ_PRICE;

    static const std::string CIIU_ID;

    static const std::string ACTIVE;

    static const std::string MAIN;

    static const std::string INPUT_ID;

    static const std::string PRODUCT_ID;

    static const std::string SUPPLIER_ID;

    static const std::string PRODUCED_QUANTITY;

    static const std::string PRICE;

    static const std::string BOUGHT_QUANTITY;

    static const std::string QUANTITY;

    static const std::string ORIG_COUNTRY_ID;

    static const std::string PROC_COUNTRY_ID;

    static const std::string YEAR_R;

    static const std::string YEAR;

    static const std::string USED_CAPACITY;

    static const std::string INSERTION_DATE;

    static const std::string OPERATING;
};

/** Paleta de colores
 *
 * Contiene un conjunto de colores seleccionados arbitrariamente para la
 * generación de archivos dot con el fin de elegir colores aleatorios para los
 * arcos.
 *
 * @author Alejandro J. Mujica
 */
struct DotColor {

    static const size_t NUM_COLORS = 15;

    static const std::string COLORS[NUM_COLORS];

    /** Retorna el color en la posición i de la paleta
     *
     * @param[in] i posición del color.
     * @return cadena identificadora del color para dot.
     */
    const std::string & operator () (const size_t & i);
};

# define GOOD_ATTRS                                                            \
    std::string name;                                                          \
    std::string technicalSpecifications;                                       \
    std::string tariffCode;                                                    \
    std::string measurementUnit;                                               \
    std::string trademark;                                                     \
    real quantity;                                                           \
    real totalQuantity;                                                      \
    real unitarianPrice;

# define INIT_GOOD_ATTRS                                                       \
    name("NULL"), technicalSpecifications("NULL"), tariffCode("NULL"),         \
    measurementUnit("NULL"), trademark("NULL"), quantity(0), totalQuantity(0), \
    unitarianPrice(0)

# define COMPANY_ATTRS                                                         \
    std::string companyName;                                                   \
    std::string companyRif;                                                    \
    std::string nationality;                                                   \
    std::string origCountry;                                                   \
    std::string procCountry;

# define INIT_COMPANY_ATTRS                                                    \
    companyName("NULL"), companyRif("NULL"), nationality("NULL"),              \
    origCountry("NULL"), procCountry("NULL")
  
/** Información completa de un producto.
 *
 * Esta estructura agrupa todos los atributos de información correspondientes
 * a un producto. Se usa para extraer de la base de datos.
 *
 * @author Alejandro J. Mujica
 */
struct ProductInfo {

    // Datos de planta
    long plantId;

    std::string plantName;

    real usedCapacity;

    // Datos de la unidad económica
    COMPANY_ATTRS

    long productId;

    //Datos comunes del bien
    GOOD_ATTRS

    ProductInfo();
};

/** Información completa de un insumo.
 *
 * Esta estructura agrupa todos los atributos de información correspondientes
 * a un insumo. Se usa para extraer de la base de datos.
 *
 * @author Alejandro J. Mujica
 */
struct InputInfo {

    COMPANY_ATTRS

    long id;

    GOOD_ATTRS

    InputInfo();
};

/** Información de alteración.
 *
 * Esta estructura agrupa los atributos requeridos para la alteración de una red
 * mediante la ejecución de la simulación.
 *
 * @author Alejandro J. Mujica
 */
struct AlterInfo {

    long numNode;

    real value;

    AlterInfo();
};

/** Información de ubicación de una planta para los indicadores.
 *
 * @author Alejandro J. Mujica
 */
struct PlantLocation {

    std::string parish;

    std::string town;

    std::string state;

    PlantLocation();
};

/// Pasa la información de un insumo a un producto.
ProductInfo inputToProduct(const InputInfo &);

/// Convierte un número en cadena numérica con formato de números en español.
std::string numtostr(const real & num, const int & numDec = 3,
                     const char & thousandSep = '.', const char & decSep = ',');

/// Sustituye los caracteres < y > por los equivalentes a html.
void modStr(std::string & str);

template <typename T>
std::string toStr(const T & number) {

    std::stringstream sstr;

    sstr.precision(PRECISION);

    sstr << number;

    return sstr.str();
}

std::string currentTime();

# endif // COMMON_H