CollectionAPI_Field.h

// Copyright (C) 2014-2023  CEA, EDF
//
// 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
//
 
#ifndef CollectionAPI_Field_H_
#define CollectionAPI_Field_H_
 
#include "CollectionAPI.h"
 
#include <CollectionPlugin_Field.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelHighAPI_Dumper;
class ModelHighAPI_Selection;
class ModelHighAPI_Integer;
class ModelHighAPI_ComponentValue;
 
class CollectionAPI_Field: public ModelHighAPI_Interface
{
public:
  COLLECTIONAPI_EXPORT
  explicit CollectionAPI_Field(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  COLLECTIONAPI_EXPORT
  virtual ~CollectionAPI_Field();
 
  INTERFACE_4(CollectionPlugin_Field::ID(),
    selection, CollectionPlugin_Field::SELECTED_ID(),
    ModelAPI_AttributeSelectionList, ,
    componentsNames, CollectionPlugin_Field::COMPONENTS_NAMES_ID(),
    ModelAPI_AttributeStringArray, ,
    stamps, CollectionPlugin_Field::STAMPS_ID(),
    ModelAPI_AttributeIntArray, ,
    values, CollectionPlugin_Field::VALUES_ID(), ModelAPI_AttributeTables ,
    )
 
  
  COLLECTIONAPI_EXPORT
  void setSelection(const std::list<ModelHighAPI_Selection>& theFieldList);
  COLLECTIONAPI_EXPORT
  void setComponentsNames(const std::list<std::string>& theNames);
  COLLECTIONAPI_EXPORT
  void setValuesType(const std::string& theType);
  COLLECTIONAPI_EXPORT
  void setStepsNum(const ModelHighAPI_Integer& theSteps);
  COLLECTIONAPI_EXPORT
  void setStamps(const std::list<ModelHighAPI_Integer>& theStamps);
  COLLECTIONAPI_EXPORT
  void addStep(const ModelHighAPI_Integer& theStepNum, const ModelHighAPI_Integer& theStamp,
    const std::list<std::list<double> >& theComponents);
  COLLECTIONAPI_EXPORT
  void addStep(const ModelHighAPI_Integer& theStepNum, const ModelHighAPI_Integer& theStamp,
    const std::list<std::list<int> >& theComponents);
  COLLECTIONAPI_EXPORT
  void addStep(const ModelHighAPI_Integer& theStepNum, const ModelHighAPI_Integer& theStamp,
    const std::list<std::list<std::string> >& theComponents);
  COLLECTIONAPI_EXPORT
  void addStep(const ModelHighAPI_Integer& theStepNum, const ModelHighAPI_Integer& theStamp,
    const std::list<std::list<bool> >& theComponents);
 
  COLLECTIONAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 
  COLLECTIONAPI_EXPORT
  std::shared_ptr<ModelAPI_AttributeTables> tableValues();
 
};
 
typedef std::shared_ptr<CollectionAPI_Field> FieldPtr;
 
COLLECTIONAPI_EXPORT
FieldPtr addField(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const ModelHighAPI_Integer& theStepsNum,
                  const std::string& theComponentType,
                  const int theComponentsNum,
                  const std::list<std::string>& theComponentNames,
                  const std::list<ModelHighAPI_Selection>& theSelectionList);
 
#endif // CollectionAPI_Field_H_