From 38327130096825d56cbc4f831bbda9212130c7eb Mon Sep 17 00:00:00 2001
From: Benjamin Reese <bareese@slac.stanford.edu>
Date: Tue, 15 Oct 2024 12:44:35 -0700
Subject: [PATCH] Add readBa method

---
 include/rogue/interfaces/stream/Frame.h | 10 ++++++++++
 src/rogue/interfaces/stream/Frame.cpp   | 19 ++++++++++++++++++-
 2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/include/rogue/interfaces/stream/Frame.h b/include/rogue/interfaces/stream/Frame.h
index 396d0d537..3334535bc 100644
--- a/include/rogue/interfaces/stream/Frame.h
+++ b/include/rogue/interfaces/stream/Frame.h
@@ -327,6 +327,7 @@ class Frame : public rogue::EnableSharedFromThis<rogue::interfaces::stream::Fram
     rogue::interfaces::stream::FrameIterator endWrite();
 
 #ifndef NO_PYTHON
+    
 
     //! Python Frame data read function
     /** Read data from Frame into passed Python byte array.
@@ -337,6 +338,15 @@ class Frame : public rogue::EnableSharedFromThis<rogue::interfaces::stream::Fram
      */
     void readPy(boost::python::object p, uint32_t offset);
 
+    //! Python Frame data read function
+    /** Read data from Frame into a python bytearray which is allocated and returned
+     *
+     * Exposed as readBa() to Python
+     * @param offset First location of Frame data to copy to byte array
+     */
+    boost::python::object readBytearrayPy(uint32_t offset);
+    
+
     //! Python Frame data write function
     /** Write data into from Frame from passed Python byte array.
      *
diff --git a/src/rogue/interfaces/stream/Frame.cpp b/src/rogue/interfaces/stream/Frame.cpp
index a3b39ed68..7bf375361 100644
--- a/src/rogue/interfaces/stream/Frame.cpp
+++ b/src/rogue/interfaces/stream/Frame.cpp
@@ -344,7 +344,8 @@ ris::FrameIterator ris::Frame::endWrite() {
 
 #ifndef NO_PYTHON
 
-//! Read up to count bytes from frame, starting from offset. Python version.
+
+//! Read bytes from frame into a passed bytearray, starting from offset. Python version.
 void ris::Frame::readPy(boost::python::object p, uint32_t offset) {
     Py_buffer pyBuf;
 
@@ -369,6 +370,20 @@ void ris::Frame::readPy(boost::python::object p, uint32_t offset) {
     PyBuffer_Release(&pyBuf);
 }
 
+//! Allocate a bytearray and read bytes from frame into it, starting at offset
+bp::object ris::Frame::readBytearrayPy(uint32_t offset) {
+    // Get the size of the frame
+    uint32_t size = getPayload();
+
+    // Create a Python bytearray to hold the data
+    boost::python::object byteArray = boost::python::eval("bytearray")(size - offset);
+
+    this->readPy(byteArray, offset);
+
+    return byteArray;
+}
+
+
 //! Write python buffer to frame, starting at offset. Python Version
 void ris::Frame::writePy(boost::python::object p, uint32_t offset) {
     Py_buffer pyBuf;
@@ -514,6 +529,8 @@ void ris::Frame::setup_python() {
         .def("getPayload", &ris::Frame::getPayload)
         .def("read", &ris::Frame::readPy, (
             bp::arg("offset")=0))
+        .def("readBa", &ris::Frame::readBytearrayPy, (
+            bp::arg("offset")=0))
         .def("write", &ris::Frame::writePy, (
             bp::arg("offset")=0))
         .def("setError", &ris::Frame::setError)