PyArrayAccessor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
#pragma once
 
#include <pybind11/pybind11.h>
// pybind11.h must come first
 
#include "AccessorVariant.h"
#include "ArrayAccessor.h"
#include "PyOwnershipManagement.h"
#include "PyTransferElement.h"
 
#include <pybind11/numpy.h>
 
namespace py = pybind11;
 
namespace ChimeraTK {
 
  /********************************************************************************************************************/
 
  class PyArrayAccessor : public PyTransferElement<PyArrayAccessor>, public PyOwnedObject {
    // Helper for constructor - note: we can move templates to the .cc file if we use them only in the same .cc file
    template<template<typename> class AccessorType>
    static ArrayAccessorVariant createAccessor(ChimeraTK::DataType type, Module* owner, const std::string& name,
        std::string unit, size_t nElements, const std::string& description,
        const std::unordered_set<std::string>& tags);
 
   public:
    PyArrayAccessor() : _accessor(ArrayOutput<int>()) {}
    PyArrayAccessor(PyArrayAccessor&&) = default;
    ~PyArrayAccessor();
 
    template<template<typename> class AccessorType>
    PyArrayAccessor(AccessorTypeTag<AccessorType>, ChimeraTK::DataType type, Module* owner, const std::string& name,
        std::string unit, size_t nElements, const std::string& description,
        const std::unordered_set<std::string>& tags = {})
    : _accessor(createAccessor<AccessorType>(type, owner, name, unit, nElements, description, tags)) {}
 
    // UserTypeTemplateVariantNoVoid expects a single template argument, std::vector has multiple (with defaults)...
    template<typename T>
    using Vector = std::vector<T>;
 
    py::object readAndGet();
 
    void setAndWrite(const UserTypeTemplateVariantNoVoid<Vector>& vec);
 
    size_t getNElements();
 
    void set(const UserTypeTemplateVariantNoVoid<Vector>& vec);
 
    py::object get() const;
 
    py::object getitem(size_t index) const;
 
    void setitem(size_t index, const UserTypeVariantNoVoid& val);
 
    void setslice(const py::slice& slice, const UserTypeVariantNoVoid& val);
 
    static std::string repr(py::object& acc);
 
    py::buffer_info getBufferInfo();
 
    py::object getattr(const std::string& name) const { return get().attr(name.c_str()); }
 
    static void bind(py::module& mod);
 
    mutable ArrayAccessorVariant _accessor;
  };
 
  /********************************************************************************************************************/
 
} // namespace ChimeraTK