source: observatorio/simulacion/SimEscenariosEconomicos-Qtgui/configuration.H @ 7bbc686

/*
  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.
*/

/*
  Este archivo contiene la definición de la clase Configuration.

  Autor: Alejandro J. Mujica
  Fecha:
*/

# ifndef CONFIGURATION_H
# define CONFIGURATION_H

# include <string>
# include <memory>

# include <QDir>

/** Contiene los valores básicos de configfuración de la aplicación.
  *
  * Esta clase está implementada bajo el patrón "Singleton" y maneja la
  * información necesaria para la conexión con la base de datos y la información
  * del directorio de usuario en el cual se almacenan los xml generados y los
  * gráficos que se visualizan.
  *
  * Estos valores son leídos de un archivo el cual se encuentra en el directorio
  * de usuario, si el archivo no existe entonces asigna los valores por omisión
  * y escribe el archivo con éstos.
  *
  * @author Alejandro J. Mujica
  */
class Configuration {

    // Ruta de instalación de la aplicación
    static const std::string APPLICATION_PATH;

    // Nombre de la aplicación.
    static const std::string APPLICATION_NAME;

    // Nombre del directorio de usuario.
    static const std::string DIR_NAME;

    // Nombre del directorio para almacenar archivos xml.
    static const std::string XML_DIR_NAME;

    // Nombre del directorio para almacenar archivos dot.
    static const std::string DOT_DIR_NAME;

    // Nombre del directorio para almacenar archivos svg.
    static const std::string SVG_DIR_NAME;

    // Nombre del archivo de configuración.
    static const std::string CONFIGURATION_FILE_NAME;

    // Nombre base del archivo en el cual se especifican las raíces de una red.
    static const std::string ROOTS_FILE_NAME;

    /*
      Nombre base de los archivos (xml, dot y svg) que contienen información
      de la red original.
    */
    static const std::string GRAPH_FILE_NAME;

    /*
      Nombre base del archivo que contiene información de la simulación que se
      desea ejecutar.
    */
    static const std::string SIMULATION_FILE_NAME;

    /*
      Nombre base de los archivos (xml, dot y svg) que contienen información
      de una red simulada.
    */
    static const std::string ALTER_GRAPH_FILE_NAME;

    // Comando para ejecutar el constructor de redes.
    static const std::string GRAPH_BUILDER_COMMAND;

    // Comando para ejecutar el simulador.
    static const std::string SIMULATION_COMMAND;

    // Nombre del archivo de texto para escribir los valores de base de datos.
    static const std::string DB_FILE_NAME;

    // Host asignado por defecto al servidor de base de datos.
    static const std::string DFT_HOST;

    // Puerto asignado por defecto al servidor de base de datos.
    static const std::string DFT_PORT;

    // Nombre de la base de datos asignado por defecto.
    static const std::string DFT_DATA_BASE;

    // Usuario asignado por defecto para el servidor de base de datos.
    static const std::string DFT_USER;

    // Password asignado por defecto para el servidor de base de datos.
    static const std::string DFT_PASSWORD;

    // Instancia única de la clase.
    static std::unique_ptr <Configuration> instance;

    std::string host;

    std::string port;

    std::string dataBase;

    std::string user;

    std::string password;

    std::string configurationFileName;

    Configuration();

    /// Carga los valores del archivo de configuración..
    void readFile();

    /// Escribe los valores sobre el archivo de configuración.
    void writeFile();


public:
    /// Referencia a la única instancia de la clase.
    static Configuration & getInstance();

    /// Asigna los valores que se seleccionaron por defecto.
    void restoreDefaultValues();

    /// Convierte
    void setValuesDefault();

    const std::string & getHost() const;

    void setHost(const std::string &);

    void setHost(std::string &&);

    const std::string & getPort() const;

    void setPort(const std::string &);

    void setPort(std::string &&);

    const std::string & getDataBase() const;

    void setDataBase(const std::string &);

    void setDataBase(std::string &&);

    const std::string & getUser() const;

    void setUser(const std::string &);

    void setUser(std::string &&);

    const std::string & getPassword() const;

    void setPassword(const std::string &);

    void setPassword(std::string &&);

    const std::string & getApplicationName() const;

    const std::string & getConfigurationFileName() const;

    const std::string & getRootsFileName() const;

    const std::string & getGraphFileName() const;

    const std::string & getSimulationFileName() const;

    const std::string & getAlterFileName() const;

    const std::string & getGraphBuilderCommand() const;

    const std::string & getSimulationCommand() const;

    const std::string & getDirName() const;

    const std::string & getXmlDirName() const;

    const std::string & getDotDirName() const;

    const std::string & getSvgDirName() const;

    const std::string getDbFileName() const;

    void createDbFile();

    void removeDbFile();
};

# define FILE_PATH(conf, prefix, name, ext) \
    (QDir::homePath().toStdString() + "/" \
    + conf.get##prefix##DirName() + "/" + conf.get##name##FileName() \
    + "." + #ext)


# endif // CONFIGURATION_H