XAO_Step.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_STEP_HXX__
#define __XAO_STEP_HXX__

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

#ifdef WIN32
#pragma warning(disable:4290) // Warning Exception ...
#endif


namespace XAO
{
    class XAO_EXPORT Step
    {
    protected:
        Step() {}

    public:
        virtual ~Step() {}

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

        const int getStep() { return m_step; }

        void setStep(const int& step) { m_step = step; }

        const int getStamp() { return m_stamp; }

        void setStamp(const int& stamp) { m_stamp = stamp; }

        const int countComponents() { return m_nbComponents; }

        const int countElements() { return m_nbElements; }

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

        virtual const std::string getStringValue(const int& element, const int& component) = 0;

        virtual void setStringValue(const int& element, const int& component, const std::string& value) = 0;

    protected:
        void checkElementIndex(const int& element) throw (XAO_Exception);
        void checkComponentIndex(const int& component)throw (XAO_Exception);

        void checkNbElements(const int& nbElements)throw (XAO_Exception);

        void checkNbComponents(const int& nbComponents)throw (XAO_Exception);

        void checkNbValues(const int& nbValues)throw (XAO_Exception);

    protected:
        int m_step;
        int m_stamp;
        int m_nbComponents;
        int m_nbElements;
    };
}


#endif /* __XAO_STEP_HXX__ */