grid3.h

Go to the documentation of this file.

// Copyright (c) 2018 Doyub Kim
//
// I am making my contributions/submissions to this project solely in my
// personal capacity and am not conveying any rights to any intellectual
// property of any third parties.
 
#ifndef INCLUDE_JET_GRID3_H_
#define INCLUDE_JET_GRID3_H_
 
#include <jet/bounding_box3.h>
#include <jet/serialization.h>
#include <jet/size3.h>
 
#include <functional>
#include <memory>
#include <string>
#include <utility>  // just make cpplint happy..
#include <vector>
 
namespace jet {
 
class Grid3 : public Serializable {
 public:
    typedef std::function<Vector3D(size_t, size_t, size_t)> DataPositionFunc;
 
    Grid3();
 
    virtual ~Grid3();
 
    virtual std::string typeName() const = 0;
 
    const Size3& resolution() const;
 
    const Vector3D& origin() const;
 
    const Vector3D& gridSpacing() const;
 
    const BoundingBox3D& boundingBox() const;
 
    DataPositionFunc cellCenterPosition() const;
 
    void forEachCellIndex(
        const std::function<void(size_t, size_t, size_t)>& func) const;
 
    void parallelForEachCellIndex(
        const std::function<void(size_t, size_t, size_t)>& func) const;
 
    virtual void serialize(std::vector<uint8_t>* buffer) const = 0;
 
    virtual void deserialize(const std::vector<uint8_t>& buffer) = 0;
 
    bool hasSameShape(const Grid3& other) const;
 
    virtual void swap(Grid3* other) = 0;
 
 protected:
    void setSizeParameters(const Size3& resolution, const Vector3D& gridSpacing,
                           const Vector3D& origin);
 
    void swapGrid(Grid3* other);
 
    void setGrid(const Grid3& other);
 
    virtual void getData(std::vector<double>* data) const = 0;
 
    virtual void setData(const std::vector<double>& data) = 0;
 
 private:
    Size3 _resolution;
    Vector3D _gridSpacing = Vector3D(1, 1, 1);
    Vector3D _origin;
    BoundingBox3D _boundingBox = BoundingBox3D(Vector3D(), Vector3D());
};
 
typedef std::shared_ptr<Grid3> Grid3Ptr;
 
#define JET_GRID3_TYPE_NAME(DerivedClassName) \
    std::string typeName() const override { return #DerivedClassName; }
 
}  // namespace jet
 
#endif  // INCLUDE_JET_GRID3_H_