src/CollectionAPI/CollectionAPI_Field.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        CollectionAPI_Field.h
   4 // Created:     16 Nov 2016
   5 // Author:      Mikhail Ponikarov
   6
   7 #ifndef CollectionAPI_Field_H_
   8 #define CollectionAPI_Field_H_
   9
  10 #include "CollectionAPI.h"
  11
  12 #include <CollectionPlugin_Field.h>
  13
  14 #include <ModelHighAPI_Interface.h>
  15 #include <ModelHighAPI_Macro.h>
  16
  17 class ModelHighAPI_Dumper;
  18 class ModelHighAPI_Selection;
  19 class ModelHighAPI_Integer;
  20 class ModelHighAPI_ComponentValue;
  21
  22 /// \class CollectionAPI_Field
  23 /// \inField CPPHighAPI
  24 /// \brief Interface for Field feature.
  25 class CollectionAPI_Field: public ModelHighAPI_Interface
  26 {
  27 public:
  28   /// Constructor without values.
  29   COLLECTIONAPI_EXPORT
  30   explicit CollectionAPI_Field(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  31
  32   /// Destructor.
  33   COLLECTIONAPI_EXPORT
  34   virtual ~CollectionAPI_Field();
  35
  36   INTERFACE_7(CollectionPlugin_Field::ID(),
  37     selection, CollectionPlugin_Field::SELECTED_ID(),
  38     ModelAPI_AttributeSelectionList, /** Field selection list*/,
  39     componentsNum, CollectionPlugin_Field::COMPONENTS_NB_ID(),
  40     ModelAPI_AttributeInteger, /** Number of components integer */,
  41     componentsNames, CollectionPlugin_Field::COMPONENTS_NAMES_ID(),
  42     ModelAPI_AttributeStringArray, /** Names of components list of strings */,
  43     valuesType, CollectionPlugin_Field::VALUES_TYPE_ID(),
  44     ModelAPI_AttributeInteger, /** Type of the values enumeration */,
  45     stepsNum, CollectionPlugin_Field::STEPS_NB_ID(),
  46     ModelAPI_AttributeInteger, /** Number of steps integer */,
  47     stamps, CollectionPlugin_Field::STAMPS_ID(),
  48     ModelAPI_AttributeIntArray, /** Identifiers of stamps */,
  49     values, CollectionPlugin_Field::VALUES_ID(), ModelAPI_AttributeTables /** Table of values */,
  50     )
  51
  52   /// Set selected objects.
  53   COLLECTIONAPI_EXPORT
  54   void setSelection(const std::list<ModelHighAPI_Selection>& theFieldList);
  55   /// Set number of components
  56   COLLECTIONAPI_EXPORT
  57   void setComponentsNum(const ModelHighAPI_Integer& theNum);
  58   /// Set names of components
  59   COLLECTIONAPI_EXPORT
  60   void setComponentsNames(const std::list<std::string>& theNames);
  61   /// Set type of values
  62   COLLECTIONAPI_EXPORT
  63   void setValuesType(const std::string& theType);
  64   /// Set number of steps
  65   COLLECTIONAPI_EXPORT
  66   void setStepsNum(const ModelHighAPI_Integer& theSteps);
  67   /// Set stamps identifiers
  68   COLLECTIONAPI_EXPORT
  69   void setStamps(const std::list<ModelHighAPI_Integer>& theStamps);
  70   /// Sets the values of specific step
  71   COLLECTIONAPI_EXPORT
  72   void addStep(const ModelHighAPI_Integer& theStepNum, const ModelHighAPI_Integer& theStamp,
  73     const std::list<std::list<ModelHighAPI_ComponentValue> >& theComponents);
  74
  75   /// Dump wrapped feature
  76   COLLECTIONAPI_EXPORT
  77   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  78 };
  79
  80 /// Pointer on Field object.
  81 typedef std::shared_ptr<CollectionAPI_Field> FieldPtr;
  82
  83 /// \inField CPPHighAPI
  84 /// \brief Create Field feature.
  85 COLLECTIONAPI_EXPORT
  86 FieldPtr addField(const std::shared_ptr<ModelAPI_Document>& thePart,
  87                   const ModelHighAPI_Integer& theStepsNum,
  88                   std::string& theComponentType,
  89                   const int theComponentsNum,
  90                   const std::list<std::string>& theComponentNames,
  91                   const std::list<ModelHighAPI_Selection>& theSelectionList);
  92
  93 #endif // CollectionAPI_Field_H_