From 224f202e0540cf578dab8150dfda8cf5bce2d1b9 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Sat, 13 Dec 2025 02:26:07 +0100 Subject: [PATCH] naming refactoring (getRegisterDefnition to retunr name and address specifically --- python/src/detector.cpp | 95 ++++++++++++++-------- slsDetectorSoftware/include/sls/Detector.h | 8 +- slsDetectorSoftware/src/CallerSpecial.cpp | 18 ++-- slsDetectorSoftware/src/Detector.cpp | 17 ++-- slsDetectorSoftware/src/DetectorImpl.cpp | 20 +++-- slsDetectorSoftware/src/DetectorImpl.h | 8 +- 6 files changed, 98 insertions(+), 68 deletions(-) diff --git a/python/src/detector.cpp b/python/src/detector.cpp index d71c1a825..a5f2725c5 100644 --- a/python/src/detector.cpp +++ b/python/src/detector.cpp @@ -946,7 +946,6 @@ void init_det(py::module &m) { (void (Detector::*)(const std::vector &)) & Detector::setRxROI, py::arg()); - CppDetectorApi.def("clearRxROI", (void (Detector::*)()) & Detector::clearRxROI); CppDetectorApi.def( @@ -1817,13 +1816,13 @@ void init_det(py::module &m) { Detector::hasRegisterDefinition, py::arg()); CppDetectorApi.def( - "getRegisterDefinition", + "getRegisterDefinitionAddress", (sls::RegisterAddress(Detector::*)(const std::string &) const) & - Detector::getRegisterDefinition, + Detector::getRegisterDefinitionAddress, py::arg()); - CppDetectorApi.def("getRegisterDefinition", + CppDetectorApi.def("getRegisterDefinitionName", (std::string(Detector::*)(sls::RegisterAddress) const) & - Detector::getRegisterDefinition, + Detector::getRegisterDefinitionName, py::arg()); CppDetectorApi.def("clearRegisterDefinitions", (void (Detector::*)()) & @@ -1842,8 +1841,8 @@ void init_det(py::module &m) { Detector::getBitDefinitionsCount); CppDetectorApi.def( "setBitDefinition", - (void (Detector::*)(const std::string &, - sls::BitAddress))&Detector::setBitDefinition, + (void (Detector::*)(const std::string &, sls::BitAddress)) & + Detector::setBitDefinition, py::arg(), py::arg()); CppDetectorApi.def("hasBitDefinition", (bool (Detector::*)(const std::string &) const) & @@ -1854,22 +1853,22 @@ void init_det(py::module &m) { Detector::hasBitDefinition, py::arg()); CppDetectorApi.def( - "getBitDefinition", - (sls::BitAddress (Detector::*)(const std::string &) const) & - Detector::getBitDefinition, + "getBitDefinitionAddress", + (sls::BitAddress(Detector::*)(const std::string &) const) & + Detector::getBitDefinitionAddress, py::arg()); - CppDetectorApi.def("getBitDefinition", - (std::string (Detector::*)(sls::BitAddress) const) & - Detector::getBitDefinition, + CppDetectorApi.def("getBitDefinitionName", + (std::string(Detector::*)(sls::BitAddress) const) & + Detector::getBitDefinitionName, py::arg()); CppDetectorApi.def("clearBitDefinitions", (void (Detector::*)()) & Detector::clearBitDefinitions); CppDetectorApi.def( "setBitDefinitions", - (void (Detector::*)(const std::map - &))&Detector::setBitDefinitions, + (void (Detector::*)(const std::map &)) & + Detector::setBitDefinitions, py::arg()); - CppDetectorApi.def("getBitDefinitions", (std::map ( + CppDetectorApi.def("getBitDefinitions", (std::map( Detector::*)() const) & Detector::getBitDefinitions); CppDetectorApi.def("configureTransceiver", @@ -2050,45 +2049,73 @@ void init_det(py::module &m) { sls::RegisterAddress, sls::Positions) const) & Detector::readRegister, py::arg(), py::arg() = Positions{}); - CppDetectorApi.def( - "readRegister", - (Result(Detector::*)(uint32_t, sls::Positions) const) & - Detector::readRegister, - py::arg(), py::arg() = Positions{}); CppDetectorApi.def( "writeRegister", (void (Detector::*)(sls::RegisterAddress, sls::RegisterValue, bool, sls::Positions)) & Detector::writeRegister, py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{}); + CppDetectorApi.def( + "setBit", + (void (Detector::*)(sls::BitAddress, bool, sls::Positions)) & + Detector::setBit, + py::arg(), py::arg() = false, py::arg() = Positions{}); + CppDetectorApi.def( + "clearBit", + (void (Detector::*)(sls::BitAddress, bool, sls::Positions)) & + Detector::clearBit, + py::arg(), py::arg() = false, py::arg() = Positions{}); + CppDetectorApi.def( + "getBit", + (Result(Detector::*)(sls::BitAddress, sls::Positions) const) & + Detector::getBit, + py::arg(), py::arg() = Positions{}); + CppDetectorApi.def("readRegister", + (Result(Detector::*)( + const std::string &, sls::Positions) const) & + Detector::readRegister, + py::arg(), py::arg() = Positions{}); + CppDetectorApi.def( + "writeRegister", + (void (Detector::*)(const std::string &, sls::RegisterValue, bool, + sls::Positions)) & + Detector::writeRegister, + py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{}); + CppDetectorApi.def( + "setBit", + (void (Detector::*)(const std::string &, bool, sls::Positions)) & + Detector::setBit, + py::arg(), py::arg() = false, py::arg() = Positions{}); + CppDetectorApi.def( + "clearBit", + (void (Detector::*)(const std::string &, bool, sls::Positions)) & + Detector::clearBit, + py::arg(), py::arg() = false, py::arg() = Positions{}); + CppDetectorApi.def( + "getBit", + (Result(Detector::*)(const std::string &, sls::Positions) const) & + Detector::getBit, + py::arg(), py::arg() = Positions{}); + CppDetectorApi.def( + "readRegister", + (Result(Detector::*)(uint32_t, sls::Positions) const) & + Detector::readRegister, + py::arg(), py::arg() = Positions{}); CppDetectorApi.def( "writeRegister", (void (Detector::*)(uint32_t, uint32_t, bool, sls::Positions)) & Detector::writeRegister, py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{}); - CppDetectorApi.def("setBit", - (void (Detector::*)(sls::BitAddress, bool, - sls::Positions))&Detector::setBit, - py::arg(), py::arg() = false, py::arg() = Positions{}); CppDetectorApi.def( "setBit", (void (Detector::*)(uint32_t, int, bool, sls::Positions)) & Detector::setBit, py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{}); - CppDetectorApi.def("clearBit", - (void (Detector::*)(sls::BitAddress, bool, - sls::Positions))&Detector::clearBit, - py::arg(), py::arg() = false, py::arg() = Positions{}); CppDetectorApi.def( "clearBit", (void (Detector::*)(uint32_t, int, bool, sls::Positions)) & Detector::clearBit, py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{}); - CppDetectorApi.def( - "getBit", - (Result (Detector::*)(sls::BitAddress, sls::Positions) const) & - Detector::getBit, - py::arg(), py::arg() = Positions{}); CppDetectorApi.def( "getBit", (Result(Detector::*)(uint32_t, int, sls::Positions) const) & diff --git a/slsDetectorSoftware/include/sls/Detector.h b/slsDetectorSoftware/include/sls/Detector.h index 3a30712b2..b805ba650 100644 --- a/slsDetectorSoftware/include/sls/Detector.h +++ b/slsDetectorSoftware/include/sls/Detector.h @@ -1851,10 +1851,10 @@ class Detector { bool hasRegisterDefinition(RegisterAddress addr) const; /** [CTB][Xilinx CTB] */ - RegisterAddress getRegisterDefinition(const std::string &name) const; + RegisterAddress getRegisterDefinitionAddress(const std::string &name) const; /** [CTB][Xilinx CTB] */ - std::string getRegisterDefinition(RegisterAddress addr) const; + std::string getRegisterDefinitionName(RegisterAddress addr) const; /** [CTB][Xilinx CTB] */ void clearRegisterDefinitions(); @@ -1879,10 +1879,10 @@ class Detector { bool hasBitDefinition(BitAddress addr) const; /** [CTB][Xilinx CTB] returns bit position and address */ - BitAddress getBitDefinition(const std::string &name) const; + BitAddress getBitDefinitionAddress(const std::string &name) const; /** [CTB][Xilinx CTB] */ - std::string getBitDefinition(BitAddress addr) const; + std::string getBitDefinitionName(BitAddress addr) const; /** [CTB][Xilinx CTB] */ void clearBitDefinitions(); diff --git a/slsDetectorSoftware/src/CallerSpecial.cpp b/slsDetectorSoftware/src/CallerSpecial.cpp index 494e53357..68a3e00e3 100644 --- a/slsDetectorSoftware/src/CallerSpecial.cpp +++ b/slsDetectorSoftware/src/CallerSpecial.cpp @@ -1479,12 +1479,12 @@ std::string Caller::define_reg(int action) { // get name from address if (is_hex_or_dec_uint(args[0])) { auto addr = RegisterAddress(args[0]); - auto t = det->getRegisterDefinition(addr); + auto t = det->getRegisterDefinitionName(addr); os << t << '\n'; } // get address from name else { - auto t = det->getRegisterDefinition(args[0]); + auto t = det->getRegisterDefinitionAddress(args[0]); os << t.str() << '\n'; } } else if (action == defs::PUT_ACTION) { @@ -1544,10 +1544,10 @@ std::string Caller::define_bit(int action) { if (action == defs::GET_ACTION) { // get position from name if (args.size() == 1) { - auto t = det->getBitDefinition(args[0]); + auto t = det->getBitDefinitionAddress(args[0]); bool found_addr = det->hasRegisterDefinition(t.address()); if (found_addr) { - os << '[' << det->getRegisterDefinition(t.address()) << ", " + os << '[' << det->getRegisterDefinitionName(t.address()) << ", " << std::to_string(t.bitPosition()) << "]\n"; } else { os << t.str() << '\n'; @@ -1558,7 +1558,7 @@ std::string Caller::define_bit(int action) { auto pos = BitAddress(parseAddress(args[0]), StringTo(args[1])); try { - auto t = det->getBitDefinition(pos); + auto t = det->getBitDefinitionName(pos); os << t << '\n'; } catch (const RuntimeError &e) { std::string err_str = e.what(); @@ -1638,8 +1638,8 @@ std::string Caller::definelist_bit(int action) { os << key << ": "; bool found_addr = det->hasRegisterDefinition(val.address()); if (found_addr) { - os << '[' << det->getRegisterDefinition(val.address()) << ", " - << std::to_string(val.bitPosition()) << "]"; + os << '[' << det->getRegisterDefinitionName(val.address()) + << ", " << std::to_string(val.bitPosition()) << "]"; } else { os << val.str(); } @@ -1772,7 +1772,7 @@ RegisterAddress Caller::parseAddress(const std::string &saddr) const { ". User defined register definitions only supported for ctb and " "xilinx_ctb. Use an actual hard coded address for this detector."); } - return det->getRegisterDefinition(saddr); + return det->getRegisterDefinitionAddress(saddr); } bool Caller::parseValidate() { @@ -1816,7 +1816,7 @@ BitAddress Caller::parseBitAddress() const { "for ctb and xilinx_ctb. Use an actual hard " "coded bit position for this detector."); } - return det->getBitDefinition(addr_or_bitname); + return det->getBitDefinitionAddress(addr_or_bitname); } // address and bit position diff --git a/slsDetectorSoftware/src/Detector.cpp b/slsDetectorSoftware/src/Detector.cpp index 7d59e80ff..a0d8eb84b 100644 --- a/slsDetectorSoftware/src/Detector.cpp +++ b/slsDetectorSoftware/src/Detector.cpp @@ -2526,12 +2526,13 @@ bool Detector::hasRegisterDefinition(RegisterAddress addr) const { return pimpl->hasRegisterDefinition(addr); } -RegisterAddress Detector::getRegisterDefinition(const std::string &name) const { - return pimpl->getRegisterDefinition(name); +RegisterAddress +Detector::getRegisterDefinitionAddress(const std::string &name) const { + return pimpl->getRegisterDefinitionAddress(name); } -std::string Detector::getRegisterDefinition(RegisterAddress addr) const { - return pimpl->getRegisterDefinition(addr); +std::string Detector::getRegisterDefinitionName(RegisterAddress addr) const { + return pimpl->getRegisterDefinitionName(addr); } void Detector::clearRegisterDefinitions() { pimpl->clearRegisterDefinitions(); } @@ -2562,12 +2563,12 @@ bool Detector::hasBitDefinition(BitAddress addr) const { return pimpl->hasBitDefinition(addr); } -BitAddress Detector::getBitDefinition(const std::string &name) const { - return pimpl->getBitDefinition(name); +BitAddress Detector::getBitDefinitionAddress(const std::string &name) const { + return pimpl->getBitDefinitionAddress(name); } -std::string Detector::getBitDefinition(BitAddress addr) const { - return pimpl->getBitDefinition(addr); +std::string Detector::getBitDefinitionName(BitAddress addr) const { + return pimpl->getBitDefinitionName(addr); } void Detector::clearBitDefinitions() { pimpl->clearBitDefinitions(); } diff --git a/slsDetectorSoftware/src/DetectorImpl.cpp b/slsDetectorSoftware/src/DetectorImpl.cpp index b29f7c05c..d3473134f 100644 --- a/slsDetectorSoftware/src/DetectorImpl.cpp +++ b/slsDetectorSoftware/src/DetectorImpl.cpp @@ -2083,13 +2083,14 @@ bool DetectorImpl::hasRegisterDefinition(RegisterAddress addr) const { } RegisterAddress -DetectorImpl::getRegisterDefinition(const std::string &name) const { +DetectorImpl::getRegisterDefinitionAddress(const std::string &name) const { if (!isChipTestBoard()) throw RuntimeError("Register Definitions only for CTB"); return ctb_shm()->getRegisterAddress(name); } -std::string DetectorImpl::getRegisterDefinition(RegisterAddress addr) const { +std::string +DetectorImpl::getRegisterDefinitionName(RegisterAddress addr) const { if (!isChipTestBoard()) throw RuntimeError("Register Definitions only for CTB"); return ctb_shm()->getRegisterName(addr); @@ -2140,13 +2141,14 @@ bool DetectorImpl::hasBitDefinition(BitAddress bitPos) const { return ctb_shm()->hasBitAddress(bitPos); } -BitAddress DetectorImpl::getBitDefinition(const std::string &name) const { +BitAddress +DetectorImpl::getBitDefinitionAddress(const std::string &name) const { if (!isChipTestBoard()) throw RuntimeError("Bit Definitions only for CTB"); return ctb_shm()->getBitAddress(name); } -std::string DetectorImpl::getBitDefinition(BitAddress bitPos) const { +std::string DetectorImpl::getBitDefinitionName(BitAddress bitPos) const { if (!isChipTestBoard()) throw RuntimeError("Bit Definitions only for CTB"); return ctb_shm()->getBitName(bitPos); @@ -2177,7 +2179,7 @@ Result DetectorImpl::readRegister(const std::string ®_name, throw RuntimeError("Register Definitions only for CTB. Use hard coded " "values instead."); } - auto addr = getRegisterDefinition(reg_name); + auto addr = getRegisterDefinitionAddress(reg_name); return readRegister(addr, pos); } @@ -2187,7 +2189,7 @@ void DetectorImpl::writeRegister(const std::string ®_name, RegisterValue val, throw RuntimeError("Register Definitions only for CTB. Use hard coded " "values instead."); } - auto addr = getRegisterDefinition(reg_name); + auto addr = getRegisterDefinitionAddress(reg_name); writeRegister(addr, val, validate, pos); } @@ -2197,7 +2199,7 @@ void DetectorImpl::setBit(const std::string &bit_name, bool validate, throw RuntimeError( "Bit Definitions only for CTB. Use hard coded values instead."); } - auto addr = getBitDefinition(bit_name); + auto addr = getBitDefinitionAddress(bit_name); setBit(addr, validate, pos); } @@ -2207,7 +2209,7 @@ void DetectorImpl::clearBit(const std::string &bit_name, bool validate, throw RuntimeError( "Bit Definitions only for CTB. Use hard coded values instead."); } - auto addr = getBitDefinition(bit_name); + auto addr = getBitDefinitionAddress(bit_name); clearBit(addr, validate, pos); } @@ -2217,7 +2219,7 @@ Result DetectorImpl::getBit(const std::string &bit_name, throw RuntimeError( "Bit Definitions only for CTB. Use hard coded values instead."); } - auto addr = getBitDefinition(bit_name); + auto addr = getBitDefinitionAddress(bit_name); return getBit(addr, pos); } diff --git a/slsDetectorSoftware/src/DetectorImpl.h b/slsDetectorSoftware/src/DetectorImpl.h index 080442fc9..31d54d609 100644 --- a/slsDetectorSoftware/src/DetectorImpl.h +++ b/slsDetectorSoftware/src/DetectorImpl.h @@ -337,8 +337,8 @@ class DetectorImpl : public virtual slsDetectorDefs { void setRegisterDefinition(const std::string &name, RegisterAddress addr); bool hasRegisterDefinition(const std::string &name) const; bool hasRegisterDefinition(RegisterAddress addr) const; - RegisterAddress getRegisterDefinition(const std::string &name) const; - std::string getRegisterDefinition(RegisterAddress addr) const; + RegisterAddress getRegisterDefinitionAddress(const std::string &name) const; + std::string getRegisterDefinitionName(RegisterAddress addr) const; void clearRegisterDefinitions(); void setRegisterDefinitions(const std::map &list); @@ -347,8 +347,8 @@ class DetectorImpl : public virtual slsDetectorDefs { void setBitDefinition(const std::string &name, BitAddress bitPos); bool hasBitDefinition(const std::string &name) const; bool hasBitDefinition(BitAddress bitPos) const; - BitAddress getBitDefinition(const std::string &name) const; - std::string getBitDefinition(BitAddress bitPos) const; + BitAddress getBitDefinitionAddress(const std::string &name) const; + std::string getBitDefinitionName(BitAddress bitPos) const; void clearBitDefinitions(); void setBitDefinitions(const std::map &list); std::map getBitDefinitions() const;