XAO_Xao.hxx

Go to the documentation of this file.

// Copyright (C) 2013-2026  CEA, EDF, 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 : Nathalie Gore (OpenCascade), Frederic Pons (OpenCascade)
 
#ifndef __XAO_XAO_HXX__
#define __XAO_XAO_HXX__
 
#include <string>
#include <list>
 
#include "XAO.hxx"
#include "XAO_Exception.hxx"
#include "XAO_XaoUtils.hxx"
#include "XAO_Geometry.hxx"
 
#ifdef WIN32
#pragma warning(disable:4290) // Warning Exception ...
#pragma warning(disable:4251) // Warning dll-interface ...
#endif
 
namespace XAO
{
    class Group;
    class Field;
    class IntegerField;
    class DoubleField;
    class BooleanField;
    class StringField;
 
    class XAO_EXPORT Xao
    {
    public:
        Xao();
        Xao(const std::string& author, const std::string& version);
        virtual ~Xao();
 
        const std::string getAuthor() const
        {
            return m_author;
        }
        void setAuthor(const std::string& author)
        {
            m_author = author;
        }
 
        const std::string getVersion() const
        {
            return m_version;
        }
        void setVersion(const std::string& version)
        {
            m_version = version;
        }
 
        //
        // Geometry
        //
 
        Geometry* getGeometry() const
        {
            return m_geometry;
        }
        void setGeometry(Geometry* geometry) 
        {
            if (m_geometry != NULL)
                throw XAO_Exception("Geometry already set.");
            m_geometry = geometry;
            m_geometry->setReadOnly();
        }
 
        //
        // Groups
        //
 
        int countGroups() const;
        Group* getGroup(int index) ;
        Group* addGroup(XAO::Dimension dim, const std::string& name = std::string("")) ;
        bool removeGroup(Group* group);
 
        //
        // Fields
        //
 
        int countFields() const;
 
        XAO::Type getFieldType(int index) ;
 
        Field* getField(int index) ;
 
        BooleanField* getBooleanField(int index) ;
        DoubleField* getDoubleField(int index) ;
        IntegerField* getIntegerField(int index) ;
        StringField* getStringField(int index) ;
 
        Field* addField(XAO::Type type, XAO::Dimension dim, int nbComponents,
                const std::string& name = std::string(""))
        ;
 
        BooleanField* addBooleanField(XAO::Dimension dim, int nbComponents,
                const std::string& name = std::string("")) ;
        IntegerField* addIntegerField(XAO::Dimension dim, int nbComponents,
                const std::string& name = std::string("")) ;
        DoubleField* addDoubleField(XAO::Dimension dim, int nbComponents,
                const std::string& name = std::string("")) ;
        StringField* addStringField(XAO::Dimension dim, int nbComponents,
                const std::string& name = std::string("")) ;
 
        bool removeField(Field* field);
 
        //
        // Import / Export
        //
        bool exportXAO(const std::string& fileName, const std::string& shapeFileName);
        const std::string getXML();
 
        bool importXAO(const std::string& fileName);
        bool setXML(const std::string& xml);
 
    private:
        void checkGeometry() const ;
        void checkGroupIndex(int index) const ;
        void checkFieldIndex(int index) const ;
        void checkGroupDimension(XAO::Dimension dim) const ;
 
    private:
        std::string m_author;
        std::string m_version;
        Geometry* m_geometry;
        std::list<Group*> m_groups;
        std::list<Field*> m_fields;
    };
 
}
 
#endif