// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
-// ICoCo file common to several codes
-// ICoCoField.h
-// version 1.2 10/05/2010
+// WARNING: this file is part of the official ICoCo API and should not be modified.
+// The official version can be found at the following URL:
+//
+// https://github.com/cea-trust-platform/icoco-coupling
-#ifndef _ICoCoField_included_
-#define _ICoCoField_included_
+#ifndef ICoCoField_included
+#define ICoCoField_included
#include <string>
-
-namespace ICoCo {
-
- class Field {
+namespace ICoCo
+{
+ /*! @brief Top abstract class defining field objects that can be exchanged via the ICoCo interface.
+ *
+ * The Field class holds the name of the field.
+ */
+ class Field
+ {
public:
- Field();
- virtual ~Field();
+ /*! @brief Set the name of the field.
+ * @param name name of the field
+ */
void setName(const std::string& name);
+
+ /*! @brief Retrieves the name of the field.
+ * @return name of the field.
+ */
const std::string& getName() const;
+
+ /*!
+ * @brief Retrieves the name of the field as a char *
+ * @return name of the field.
+ */
const char* getCharName() const;
-
+
+ protected:
+ Field();
+ virtual ~Field();
+
private:
std::string* _name;
};
-}
+} // namespace ICoCo
#endif
