src/GDMLPlugin/GDMLPlugin_Ellipsoid.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GDMLPLUGIN_ELLIPSOID_H_
  21 #define GDMLPLUGIN_ELLIPSOID_H_
  22
  23 #include <GDMLPlugin.h>
  24 #include <ModelAPI_Feature.h>
  25 #include <GeomAlgoAPI_Ellipsoid.h>
  26
  27 class GeomAPI_Shape;
  28 class ModelAPI_ResultBody;
  29
  30 /**\class GDMLPlugin_Ellipsoid
  31  * \ingroup Plugins
  32  * \brief Feature for creation of a GDML Ellipsoid solid.
  33  */
  34 class GDMLPlugin_Ellipsoid : public ModelAPI_Feature
  35 {
  36  public:
  37   /// Cone segment kind
  38   inline static const std::string& ID()
  39   {
  40     static const std::string MY_CONESEGMENT_ID("Ellipsoid");
  41     return MY_CONESEGMENT_ID;
  42   }
  43   /// attribute name of the inner radius at base of cone
  44   inline static const std::string& AX_ID()
  45   {
  46     static const std::string MY_AX_ID("ax");
  47     return MY_AX_ID;
  48   }
  49   /// attribute name of the outer radius at base of cone
  50   inline static const std::string& BY_ID()
  51   {
  52     static const std::string MY_BY_ID("by");
  53     return MY_BY_ID;
  54   }
  55   /// attribute name of the inner radius at top of cone
  56   inline static const std::string& CZ_ID()
  57   {
  58     static const std::string MY_CZ_ID("cz");
  59     return MY_CZ_ID;
  60   }
  61   /// attribute name of the outer radius at top of cone
  62   inline static const std::string& ZCUT1_ID()
  63   {
  64     static const std::string MY_ZCUT1_ID("zcut1");
  65     return MY_ZCUT1_ID;
  66   }
  67   /// attribute name of the outer radius at top of cone
  68   inline static const std::string& USE_ZCUT1_ID()
  69   {
  70     static const std::string MY_USE_ZCUT1_ID("use_zcut1");
  71     return MY_USE_ZCUT1_ID;
  72   }
  73   /// attribute name of the outer radius at top of cone
  74   inline static const std::string& USE_ZCUT2_ID()
  75   {
  76     static const std::string MY_USE_ZCUT2_ID("use_zcut2");
  77     return MY_USE_ZCUT2_ID;
  78   }
  79   /// attribute name of the outer radius at top of cone
  80   inline static const std::string& ZCUT2_ID()
  81   {
  82     static const std::string MY_ZCUT2_ID("zcut2");
  83     return MY_ZCUT2_ID;
  84   }
  85
  86   /// Returns the kind of a feature
  87   GDMLPLUGIN_EXPORT virtual const std::string& getKind()
  88   {
  89     static std::string MY_KIND = GDMLPlugin_Ellipsoid::ID();
  90     return MY_KIND;
  91   }
  92
  93   /// Creates a new part document if needed
  94   GDMLPLUGIN_EXPORT virtual void execute();
  95
  96   /// Request for initialization of data model of the feature: adding all attributes
  97   GDMLPLUGIN_EXPORT virtual void initAttributes();
  98
  99   /// Use plugin manager for features creation
 100   GDMLPlugin_Ellipsoid();
 101
 102  private:
 103   /// Load Naming data structure of the feature to the document
 104   void loadNamingDS(std::shared_ptr<GeomAlgoAPI_Ellipsoid> theEllipsoidAlgo,
 105                     std::shared_ptr<ModelAPI_ResultBody> theResultEllipsoid);
 106
 107 };
 108
 109 #endif // GDMLPLUGIN_ELLIPSOID_H_