Blame view

src/connectordata.h 3.1 KB
30448f62   Peter M. Groen   Replace Qt with s...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
  #pragma once
  
  #include <string>
  
  namespace osdev {
  namespace components {
  
  /*  ______________________________________
   * / It's hard to think of you as the end \
   * | result of millions of years of       |
   * \ evolution.                           /
   *  --------------------------------------
   *   \
   *    \
   *        .--.
   *       |o_o |
   *       |:_/ |
   *      //   \ \
   *     (|     | )
   *    /'\_   _/`\
   *    \___)=(___/
   ********************************************
   */
  /*!
   * \brief The ConnectorData class
   */
  
  class ConnectorData
  {
  public:
      /*!
       * \brief ConnectorData
       */
      ConnectorData();
  
      /*!
       * \brief ConnectorData
       * \param name The name of the ConnectorData.
       * \param type The type of the ConnectorData.
       * \param id The id of the ConnectorData.
       * \param defaultValue The default of the ConnectorData.
       * \param excludeFromIdentityCheck Flag that indicates if this variable should participate in a record identity check. Default false.
       */
      ConnectorData(const std::string& name, const std::string& type, const std::string& id, const string& defaultValue, bool excludeFromIdentityCheck = false);
  
      /*!
       * \brief setName
       * \param name The name of the ConnectorData.
       */
      void setName(const std::string& name);
  
      /*!
       * \brief setType
       * \param type The type of the ConnectorData.
       */
      void setType(const std::string& type);
  
      /*!
       * \brief setId
       * \param id The id of the ConnectorData.
       */
      void setId(const std::string& id);
  
      /*!
       * \brief setDefault
       * \param defaultValue The default of the ConnectorData.
       */
      void setDefault(const std::string& defaultValue);
  
      /*!
       * \brief set excludeFromIdentityCheck flag value
       * \param value The excludeFromIdentityCheck flag value of the ConnectorData.
       */
      void setExcludeFromIdentityCheck(bool value);
  
      /*!
       * \return The name of the ConnectorData.
       */
      const std::string& name() const { return m_name; }
  
      /*!
       * \return The type of the ConnectorData.
       */
      const std::string& type() const { return m_type; }
  
      /*!
       * \return The id of the ConnectorData. A null string means that there is no id.
       */
      const std::string& id() const { return m_id; }
  
      /*!
       * \return default The default of the ConnectorData.
       */
      const std::string& Default() const { return m_default; }
  
      /*!
       * \return the excludeFromIdentityCheck flag
       */
      bool excludeFromIdentityCheck() const { return m_excludeFromIdentityCheck; }
  
  private:
      std::string m_name;                  ///< The name of the variable this connector represents.
      std::string m_type;                  ///< The type of the variable this connector represents.
      std::string m_id;                    ///< The id of the variable this connector represents.
      std::string m_default;               ///< The default value of the variable this connector represents.
      bool m_excludeFromIdentityCheck;     ///< Flag that indicates if this variable should participate in a record identity check.
  };
  
  } // namespace components
  } // namespace osdev