Merge from BR_V7_main_Field branch (02/09/2013)

[modules/geom.git] / src / XAO / XAO_BooleanField.hxx

diff --git a/src/XAO/XAO_BooleanField.hxx b/src/XAO/XAO_BooleanField.hxx
new file mode 100644 (file)
index 0000000..9860c46
--- /dev/null
+++ b/src/XAO/XAO_BooleanField.hxx
@@ -0,0 +1,77 @@
+// Copyright (C) 2013  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+// Author : Frederic Pons (OpenCascade)
+
+#ifndef __XAO_BOOLEANFIELD_HXX__
+#define __XAO_BOOLEANFIELD_HXX__
+
+#include <string>
+
+#include "XAO_XaoUtils.hxx"
+#include "XAO_Field.hxx"
+#include "XAO_BooleanStep.hxx"
+
+namespace XAO
+{
+    /**
+     * @class BooleanField
+     * Represents a field with boolean values.
+     */
+    class BooleanField : public Field
+    {
+    public:
+        /**
+         * Constructor.
+         * @param dimension the dimension of the field.
+         * @param nbElements the number of elements.
+         * @param nbComponents the number of components.
+         * @param name the name of the field.
+         */
+        BooleanField(const XAO::Dimension& dimension, const int& nbElements, const int& nbComponents, const std::string& name);
+
+        virtual const XAO::Type getType() { return XAO::BOOLEAN; }
+
+        virtual Step* addNewStep(const int& step) throw (XAO_Exception);
+
+        /**
+         * Adds a new step.
+         * @param step the number of the step.
+         * @return the newly created step.
+         */
+        BooleanStep* addStep(const int& step) throw (XAO_Exception);
+
+        /**
+         * Adds a new step.
+         * @param step the number of the step.
+         * @param stamp the stamp of the step.
+         * @return the newly created step.
+         */
+        BooleanStep* addStep(const int& step, const int& stamp)
+        throw (XAO_Exception);
+
+        /**
+         * Gets the step of given index.
+         * @param index the index.
+         * @return the step for the given index.
+         */
+        BooleanStep* getStep(const int& index) throw (XAO_Exception);
+    };
+}
+
+#endif /* __XAO_BOOLEANFIELD_HXX__ */