[CardFinder] Publish CardFinder API

Author: kostorr

CMakeLists.txt

@@ -122,6 +122,7 @@ if(PDA_FOUND)
     src/DmaChannelPdaBase.cxx
     src/BarInterfaceBase.cxx
     src/CardConfigurator.cxx
+    src/CardFinder.cxx
     src/Crorc/Crorc.cxx
     src/Crorc/CrorcDmaChannel.cxx
     src/Crorc/CrorcBar.cxx

include/ReadoutCard/CardConfigurator.h

@@ -13,8 +13,8 @@
 ///
 /// \author Kostas Alexopoulos ([email protected])
 
-#ifndef ALICEO2_SRC_READOUTCARD_CARDCONFIGURATOR_H_
-#define ALICEO2_SRC_READOUTCARD_CARDCONFIGURATOR_H_
+#ifndef ALICEO2_INCLUDE_READOUTCARD_CARDCONFIGURATOR_H_
+#define ALICEO2_INCLUDE_READOUTCARD_CARDCONFIGURATOR_H_
 
 #include "ReadoutCard/Parameters.h"
 

src/CardDescriptor.h include/ReadoutCard/CardDescriptor.hsrc/CardDescriptor.h renamed to include/ReadoutCard/CardDescriptor.h

@@ -13,8 +13,8 @@
 ///
 /// \author Pascal Boeschoten ([email protected])
 
-#ifndef ALICEO2_SRC_READOUTCARD_CARDDESCRIPTOR_H_
-#define ALICEO2_SRC_READOUTCARD_CARDDESCRIPTOR_H_
+#ifndef ALICEO2_INCLUDE_READOUTCARD_CARDDESCRIPTOR_H_
+#define ALICEO2_INCLUDE_READOUTCARD_CARDDESCRIPTOR_H_
 
 #include <boost/optional.hpp>
 #include "ReadoutCard/CardType.h"
@@ -38,4 +38,4 @@ struct CardDescriptor {
 } // namespace roc
 } // namespace AliceO2
 
-#endif // ALICEO2_SRC_READOUTCARD_CARDDESCRIPTOR_H_
+#endif // ALICEO2_INCLUDE_READOUTCARD_CARDDESCRIPTOR_H_

include/ReadoutCard/CardFinder.h

@@ -0,0 +1,31 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \file CardFinder.h
+/// \brief Definitions for the CardFinder methods.
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#ifndef ALICEO2_INCLUDE_READOUTCARD_CARDFINDER_H_
+#define ALICEO2_INCLUDE_READOUTCARD_CARDFINDER_H_
+
+#include "ReadoutCard/CardDescriptor.h"
+
+namespace AliceO2
+{
+namespace roc
+{
+
+std::vector<CardDescriptor> findCards(); //Possibly extend with card types (crorc, cru)
+
+} // namespace roc
+} // namespace AliceO2
+
+#endif // ALICEO2_INCLUDE_READOUTCARD_CARDFINDER_H_

src/CardFinder.cxx

@@ -0,0 +1,31 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \file CardFinder.cxx
+/// \brief Implementation of the CardFinder collection of functions.
+///
+/// \author Kostas Alexopoulos ([email protected])
+
+#include "ReadoutCard/CardFinder.h"
+#include "RocPciDevice.h"
+
+namespace AliceO2
+{
+namespace roc
+{
+
+std::vector<CardDescriptor> findCards()
+{
+  std::vector<CardDescriptor> cards = RocPciDevice::findSystemDevices();
+  return cards;
+}
+
+} // namespace roc
+} // namespace AliceO2

src/DmaChannelBase.h

@@ -22,10 +22,10 @@
 #include <mutex>
 #include <boost/optional.hpp>
 #include <InfoLogger/InfoLogger.hxx>
-#include "CardDescriptor.h"
 #include "ChannelPaths.h"
 #include "ExceptionInternal.h"
 #include "Pda/PdaLock.h"
+#include "ReadoutCard/CardDescriptor.h"
 #include "ReadoutCard/DmaChannelInterface.h"
 #include "ReadoutCard/Exception.h"
 #include "ReadoutCard/InterprocessLock.h"

src/Factory/ChannelFactoryUtils.h

@@ -15,8 +15,8 @@
 
 #include <map>
 #include <algorithm>
-#include "CardDescriptor.h"
 #include "ExceptionInternal.h"
+#include "ReadoutCard/CardDescriptor.h"
 #include "ReadoutCard/CardType.h"
 #include "ReadoutCard/Parameters.h"
 #ifdef ALICEO2_READOUTCARD_PDA_ENABLED

src/RocPciDevice.h

@@ -18,9 +18,9 @@
 
 #include <memory>
 #include <string>
-#include "CardDescriptor.h"
 #include "Pda/PdaDevice.h"
 #include "ReadoutCard/CardType.h"
+#include "ReadoutCard/CardDescriptor.h"
 #include "ReadoutCard/Parameters.h"
 #include "ReadoutCard/ParameterTypes/PciAddress.h"
 #include "ReadoutCard/PciId.h"

test/TestChannelPaths.cxx

@@ -10,7 +10,7 @@
 #define BOOST_TEST_DYN_LINK
 #include <boost/test/unit_test.hpp>
 #include <assert.h>
-#include "CardDescriptor.h"
+#include "ReadoutCard/CardDescriptor.h"
 
 BOOST_AUTO_TEST_CASE(ChannelPathsTest)
 {