src/SimanIO_Link.hxx

   1 #ifndef SIMANIO_LINK_H
   2 #define SIMANIO_LINK_H
   3
   4 #include <SimanIO_Configuration.hxx>
   5
   6 /**
   7  * \brief Class for creation of connection with SIMAN database.
   8  */
   9
  10 class SimanIO_Link {
  11   std::string myStudy;    ///< identifier of the study in the SIMAN
  12   std::string myScenario; ///< identifier of the scenario in the SIMAN
  13   std::string myUser;     ///< identifier of the user in the SIMAN
  14 public:
  15   /**
  16    * Initializes the connection to the data base with certain connection properties.
  17    * \param theStudyID defines the selected study id in SIMAN
  18    * \param theScenarioID defines the secnario id in SIMAN
  19    * \param theUserID identifies the current SIMAN user id
  20    */
  21   SimanIO_Link(const char* theStudyID, const char* theScenarioID, const char* theUserID);
  22
  23   /**
  24    * Checks the connection status.
  25    * \returns true if data base is currently connected.
  26    */
  27   bool IsConnected();
  28
  29   /**
  30    * Retrieves scenario "conf" file from the SIMAN.
  31    * \returns CFG file interface, connected to the received file to get data from it.
  32    */
  33   SimanIO_Configuration RetrieveConf();
  34
  35   /**
  36    * Stores configuration information to the SIMAN.
  37    * \param theConf interface for configuration data storage; data in this interface will be stored in SIMAN
  38    */
  39   void StoreConf(/*const*/ SimanIO_Configuration& theConf);
  40 };
  41
  42 #endif