XAO_Field.hxx

Go to the documentation of this file.

// Copyright (C) 2013-2016  CEA/DEN, EDF R&D, OPEN CASCADE
//
// 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, or (at your option) any later version.
//
// 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_FIELD_HXX__
#define __XAO_FIELD_HXX__

#include <string>
#include <vector>

#include "XAO.hxx"
#include "XAO_XaoUtils.hxx"
#include "XAO_Step.hxx"

#ifdef WIN32
#pragma warning(disable:4290) // Warning Exception ...
#pragma warning(disable:4251) // Warning dll-interface ...
#endif


namespace XAO
{
    typedef std::vector<Step*>::iterator stepIterator;

    class XAO_EXPORT Field
    {
    protected:
        Field(const XAO::Dimension& dimension,
              const int& nbElements, const int& nbComponents, const std::string& name);

    public:
        static Field* createField(const XAO::Type& type, const XAO::Dimension& dimension,
                                  const int& nbElements, const int& nbComponents,
                                  const std::string& name = std::string(""))
        throw (XAO_Exception);

        virtual ~Field();

        virtual const XAO::Type getType() = 0;

        const std::string getName() const
        {
            return m_name;
        }

        void setName(const std::string& name)
        {
            m_name = name;
        }

        const XAO::Dimension getDimension() const
        {
            return m_dimension;
        }

        const int countElements() const
        {
            return m_nbElements;
        }

        const int countComponents() const
        {
            return m_nbComponents;
        }

        const int countValues() const
        {
            return m_nbElements * m_nbComponents;
        }

        const int countSteps() const { return m_steps.size(); }

        const std::string getComponentName(const int& index) throw (XAO_Exception);

        void setComponentName(const int& componentIndex, const std::string& name) throw (XAO_Exception);

        void setComponentsNames(const std::vector<std::string>& names) throw (XAO_Exception);

        virtual Step* addNewStep(const int& number) throw (XAO_Exception) = 0;

        bool removeStep(Step* step);

        bool hasStep(const int& step);

        stepIterator begin() { return m_steps.begin(); }

        stepIterator end() { return m_steps.end(); }

    protected:
        void checkComponent(const int& component) throw (XAO_Exception);
        void checkStepIndex(const int& step) throw (XAO_Exception);

    protected:
        std::string m_name;
        XAO::Dimension m_dimension;

        int m_nbComponents;
        std::vector<std::string> m_components;
        int m_nbElements;

        std::vector<Step*> m_steps;
    };
}

#endif