DataSet.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
#ifndef viskores_cont_DataSet_h
#define viskores_cont_DataSet_h
 
#include <viskores/cont/viskores_cont_export.h>
 
#include <viskores/cont/ArrayHandle.h>
#include <viskores/cont/CoordinateSystem.h>
#include <viskores/cont/ErrorBadValue.h>
#include <viskores/cont/Field.h>
#include <viskores/cont/UnknownArrayHandle.h>
#include <viskores/cont/UnknownCellSet.h>
#include <viskores/cont/internal/FieldCollection.h>
 
namespace viskores
{
namespace cont
{
 
VISKORES_CONT_EXPORT VISKORES_CONT std::string& GlobalGhostCellFieldName() noexcept;
 
VISKORES_CONT_EXPORT VISKORES_CONT const std::string& GetGlobalGhostCellFieldName() noexcept;
 
VISKORES_CONT_EXPORT VISKORES_CONT void SetGlobalGhostCellFieldName(
  const std::string& name) noexcept;
 
class VISKORES_CONT_EXPORT DataSet
{
public:
  DataSet() = default;
 
  DataSet(viskores::cont::DataSet&&) = default;
 
  DataSet(const viskores::cont::DataSet&) = default;
 
  viskores::cont::DataSet& operator=(viskores::cont::DataSet&&) = default;
 
  viskores::cont::DataSet& operator=(const viskores::cont::DataSet&) = default;
 
  VISKORES_CONT void Clear();
 
  VISKORES_CONT viskores::Id GetNumberOfCells() const;
 
  VISKORES_CONT viskores::Id GetNumberOfPoints() const;
 
  VISKORES_CONT void AddField(const Field& field);
 
  VISKORES_CONT void AddField(const std::string& name,
                              viskores::cont::Field::Association association,
                              const viskores::cont::UnknownArrayHandle& data);
 
  VISKORES_CONT
  const viskores::cont::Field& GetField(viskores::Id index) const
  {
    return this->Fields.GetField(index);
  }
 
  VISKORES_CONT
  viskores::cont::Field& GetField(viskores::Id index) { return this->Fields.GetField(index); }
 
  VISKORES_CONT
  bool HasField(
    const std::string& name,
    viskores::cont::Field::Association assoc = viskores::cont::Field::Association::Any) const
  {
    return this->Fields.HasField(name, assoc);
  }
 
  VISKORES_CONT
  bool HasCellField(const std::string& name) const
  {
    return (this->Fields.GetFieldIndex(name, viskores::cont::Field::Association::Cells) != -1);
  }
 
  VISKORES_CONT
  bool HasGhostCellField() const;
 
  VISKORES_CONT
  const std::string& GetGhostCellFieldName() const;
 
  VISKORES_CONT
  bool HasPointField(const std::string& name) const
  {
    return (this->Fields.GetFieldIndex(name, viskores::cont::Field::Association::Points) != -1);
  }
 
 
  VISKORES_CONT
  viskores::Id GetFieldIndex(
    const std::string& name,
    viskores::cont::Field::Association assoc = viskores::cont::Field::Association::Any) const
  {
    return this->Fields.GetFieldIndex(name, assoc);
  }
 
  VISKORES_CONT
  const viskores::cont::Field& GetField(
    const std::string& name,
    viskores::cont::Field::Association assoc = viskores::cont::Field::Association::Any) const
  {
    return this->Fields.GetField(name, assoc);
  }
 
 
  VISKORES_CONT
  viskores::cont::Field& GetField(
    const std::string& name,
    viskores::cont::Field::Association assoc = viskores::cont::Field::Association::Any)
  {
    return this->Fields.GetField(name, assoc);
  }
 
  VISKORES_CONT
  const viskores::cont::Field& GetCellField(const std::string& name) const
  {
    return this->GetField(name, viskores::cont::Field::Association::Cells);
  }
 
  VISKORES_CONT
  viskores::cont::Field& GetCellField(const std::string& name)
  {
    return this->GetField(name, viskores::cont::Field::Association::Cells);
  }
 
  VISKORES_CONT
  viskores::cont::Field GetGhostCellField() const;
 
  VISKORES_CONT
  const viskores::cont::Field& GetPointField(const std::string& name) const
  {
    return this->GetField(name, viskores::cont::Field::Association::Points);
  }
 
  VISKORES_CONT
  viskores::cont::Field& GetPointField(const std::string& name)
  {
    return this->GetField(name, viskores::cont::Field::Association::Points);
  }
 
  VISKORES_CONT
  void AddPointField(const std::string& fieldName, const viskores::cont::UnknownArrayHandle& field)
  {
    this->AddField(fieldName, viskores::cont::Field::Association::Points, field);
  }
 
  template <typename T, typename Storage>
  VISKORES_CONT void AddPointField(const std::string& fieldName,
                                   const viskores::cont::ArrayHandle<T, Storage>& field)
  {
    this->AddPointField(fieldName, viskores::cont::UnknownArrayHandle{ field });
  }
 
  template <typename T>
  VISKORES_CONT void AddPointField(const std::string& fieldName, const std::vector<T>& field)
  {
    this->AddField(make_Field(
      fieldName, viskores::cont::Field::Association::Points, field, viskores::CopyFlag::On));
  }
 
  template <typename T>
  VISKORES_CONT void AddPointField(const std::string& fieldName,
                                   const T* field,
                                   const viskores::Id& n)
  {
    this->AddField(make_Field(
      fieldName, viskores::cont::Field::Association::Points, field, n, viskores::CopyFlag::On));
  }
 
  VISKORES_CONT
  void AddCellField(const std::string& fieldName, const viskores::cont::UnknownArrayHandle& field)
  {
    this->AddField(fieldName, viskores::cont::Field::Association::Cells, field);
  }
 
  template <typename T, typename Storage>
  VISKORES_CONT void AddCellField(const std::string& fieldName,
                                  const viskores::cont::ArrayHandle<T, Storage>& field)
  {
    this->AddCellField(fieldName, viskores::cont::UnknownArrayHandle{ field });
  }
 
  template <typename T>
  VISKORES_CONT void AddCellField(const std::string& fieldName, const std::vector<T>& field)
  {
    this->AddField(make_Field(
      fieldName, viskores::cont::Field::Association::Cells, field, viskores::CopyFlag::On));
  }
 
  template <typename T>
  VISKORES_CONT void AddCellField(const std::string& fieldName,
                                  const T* field,
                                  const viskores::Id& n)
  {
    this->AddField(make_Field(
      fieldName, viskores::cont::Field::Association::Cells, field, n, viskores::CopyFlag::On));
  }
 
  VISKORES_CONT void SetGhostCellFieldName(const std::string& name);
 
  VISKORES_CONT void SetGhostCellField(const std::string& name);
 
  VISKORES_CONT void SetGhostCellField(const viskores::cont::Field& field);
  VISKORES_CONT void SetGhostCellField(const std::string& fieldName,
                                       const viskores::cont::UnknownArrayHandle& field);
 
  VISKORES_CONT void SetGhostCellField(const viskores::cont::UnknownArrayHandle& field);
 
  VISKORES_DEPRECATED(2.0, "Use SetGhostCellField.")
  VISKORES_CONT
  void AddGhostCellField(const std::string& fieldName,
                         const viskores::cont::UnknownArrayHandle& field)
  {
    this->SetGhostCellField(fieldName, field);
  }
 
  VISKORES_DEPRECATED(2.0, "Use SetGhostCellField.")
  VISKORES_CONT
  void AddGhostCellField(const viskores::cont::UnknownArrayHandle& field)
  {
    this->SetGhostCellField(field);
  }
 
  VISKORES_DEPRECATED(2.0, "Use SetGhostCellField.")
  VISKORES_CONT
  void AddGhostCellField(const viskores::cont::Field& field) { this->SetGhostCellField(field); }
 
 
  VISKORES_CONT
  viskores::IdComponent AddCoordinateSystem(const viskores::cont::CoordinateSystem& cs);
 
  VISKORES_CONT viskores::IdComponent AddCoordinateSystem(
    const std::string& name,
    const viskores::cont::UnknownArrayHandle& data);
 
  VISKORES_CONT viskores::IdComponent AddCoordinateSystem(const std::string& pointFieldName);
 
  VISKORES_CONT
  bool HasCoordinateSystem(const std::string& name) const
  {
    return this->GetCoordinateSystemIndex(name) >= 0;
  }
 
  VISKORES_CONT
  viskores::cont::CoordinateSystem GetCoordinateSystem(viskores::Id index = 0) const;
 
  VISKORES_CONT
  viskores::IdComponent GetCoordinateSystemIndex(const std::string& name) const;
 
  VISKORES_CONT const std::string& GetCoordinateSystemName(viskores::Id index = 0) const;
 
  VISKORES_CONT
  viskores::cont::CoordinateSystem GetCoordinateSystem(const std::string& name) const;
 
  template <typename CellSetType>
  VISKORES_CONT void SetCellSet(const CellSetType& cellSet)
  {
    VISKORES_IS_KNOWN_OR_UNKNOWN_CELL_SET(CellSetType);
    this->SetCellSetImpl(cellSet);
  }
 
  VISKORES_CONT
  const viskores::cont::UnknownCellSet& GetCellSet() const { return this->CellSet; }
 
  VISKORES_CONT
  viskores::cont::UnknownCellSet& GetCellSet() { return this->CellSet; }
 
  VISKORES_CONT
  viskores::IdComponent GetNumberOfFields() const { return this->Fields.GetNumberOfFields(); }
 
  VISKORES_CONT
  viskores::IdComponent GetNumberOfCoordinateSystems() const
  {
    return static_cast<viskores::IdComponent>(this->CoordSystemNames.size());
  }
 
  VISKORES_CONT
  void CopyStructure(const viskores::cont::DataSet& source);
 
  VISKORES_CONT void ConvertToExpected();
 
  VISKORES_CONT
  void PrintSummary(std::ostream& out) const;
 
private:
  std::vector<std::string> CoordSystemNames;
  viskores::cont::internal::FieldCollection Fields{
    viskores::cont::Field::Association::WholeDataSet,
    viskores::cont::Field::Association::Points,
    viskores::cont::Field::Association::Cells
  };
 
  viskores::cont::UnknownCellSet CellSet;
  std::shared_ptr<std::string> GhostCellName;
 
  VISKORES_CONT void SetCellSetImpl(const viskores::cont::UnknownCellSet& cellSet);
};
 
} // namespace cont
} // namespace viskores
 
//=============================================================================
// Specializations of serialization related classes
namespace viskores
{
namespace cont
{
 
template <typename... CellSetTypes>
struct DataSetWithCellSetTypes
{
  viskores::cont::DataSet DataSet;
 
  DataSetWithCellSetTypes() = default;
 
  explicit DataSetWithCellSetTypes(const viskores::cont::DataSet& dataset)
    : DataSet(dataset)
  {
  }
};
 
template <typename... CellSetTypes>
struct DataSetWithCellSetTypes<viskores::List<CellSetTypes...>>
  : DataSetWithCellSetTypes<CellSetTypes...>
{
  using DataSetWithCellSetTypes<CellSetTypes...>::DataSetWithCellSetTypes;
};
 
template <typename FieldTypeList = VISKORES_DEFAULT_TYPE_LIST,
          typename CellSetTypesList = VISKORES_DEFAULT_CELL_SET_LIST>
struct VISKORES_DEPRECATED(
  2.1,
  "Serialize DataSet directly or use DataSetWithCellSetTypes for weird CellSets.")
  SerializableDataSet : DataSetWithCellSetTypes<CellSetTypesList>
{
  using DataSetWithCellSetTypes<CellSetTypesList>::DataSetWithCellSetTypes;
};
 
}
} // viskores::cont
 
namespace mangled_diy_namespace
{
 
template <>
struct VISKORES_CONT_EXPORT Serialization<viskores::cont::DataSet>
{
  static VISKORES_CONT void foo();
  static VISKORES_CONT void save(BinaryBuffer& bb, const viskores::cont::DataSet& obj);
  static VISKORES_CONT void load(BinaryBuffer& bb, viskores::cont::DataSet& obj);
};
 
template <typename... CellSetTypes>
struct Serialization<viskores::cont::DataSetWithCellSetTypes<CellSetTypes...>>
{
private:
  using Type = viskores::cont::DataSetWithCellSetTypes<CellSetTypes...>;
 
public:
  static VISKORES_CONT void save(BinaryBuffer& bb, const Type& serializable)
  {
    const auto& dataset = serializable.DataSet;
 
    viskoresdiy::save(bb, dataset.GetCellSet().ResetCellSetList(viskores::List<CellSetTypes...>{}));
 
    viskores::IdComponent numberOfFields = dataset.GetNumberOfFields();
    viskoresdiy::save(bb, numberOfFields);
    for (viskores::IdComponent i = 0; i < numberOfFields; ++i)
    {
      viskoresdiy::save(bb, dataset.GetField(i));
    }
 
    viskores::IdComponent numberOfCoordinateSystems = dataset.GetNumberOfCoordinateSystems();
    viskoresdiy::save(bb, numberOfCoordinateSystems);
    for (viskores::IdComponent i = 0; i < numberOfCoordinateSystems; ++i)
    {
      viskoresdiy::save(bb, dataset.GetCoordinateSystemName(i));
    }
  }
 
  static VISKORES_CONT void load(BinaryBuffer& bb, Type& serializable)
  {
    auto& dataset = serializable.DataSet;
    dataset = {}; // clear
 
    viskores::cont::UncertainCellSet<viskores::List<CellSetTypes...>> cells;
    viskoresdiy::load(bb, cells);
    dataset.SetCellSet(cells);
 
    viskores::IdComponent numberOfFields = 0;
    viskoresdiy::load(bb, numberOfFields);
    for (viskores::IdComponent i = 0; i < numberOfFields; ++i)
    {
      viskores::cont::Field field;
      viskoresdiy::load(bb, field);
      dataset.AddField(field);
    }
 
    viskores::IdComponent numberOfCoordinateSystems = 0;
    viskoresdiy::load(bb, numberOfCoordinateSystems);
    for (viskores::IdComponent i = 0; i < numberOfCoordinateSystems; ++i)
    {
      std::string coordName;
      viskoresdiy::load(bb, coordName);
      dataset.AddCoordinateSystem(coordName);
    }
  }
};
 
template <typename... CellSetTypes>
struct Serialization<viskores::cont::DataSetWithCellSetTypes<viskores::List<CellSetTypes...>>>
  : Serialization<viskores::cont::DataSetWithCellSetTypes<CellSetTypes...>>
{
};
 
VISKORES_DEPRECATED_SUPPRESS_BEGIN
template <typename FieldTypeList, typename CellSetTypesList>
struct Serialization<viskores::cont::SerializableDataSet<FieldTypeList, CellSetTypesList>>
  : Serialization<viskores::cont::DataSetWithCellSetTypes<CellSetTypesList>>
{
};
VISKORES_DEPRECATED_SUPPRESS_END
 
} // diy
 
#endif //viskores_cont_DataSet_h