HwInterface.hpp

Go to the documentation of this file.

/*
---------------------------------------------------------------------------

    This file is part of uHAL.

    uHAL is a hardware access library and programming framework
    originally developed for upgrades of the Level-1 trigger of the CMS
    experiment at CERN.

    uHAL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    uHAL is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with uHAL.  If not, see <http://www.gnu.org/licenses/>.


      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk

      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch

---------------------------------------------------------------------------
*/

#ifndef _uhal_HwInterface_hpp_
#define _uhal_HwInterface_hpp_

#include <stdint.h>
#include <string>
#include <vector>

#include <boost/shared_ptr.hpp>

#include "uhal/ClientInterface.hpp" // IWYU pragma: keep
#include "uhal/Node.hpp"            // IWYU pragma: keep


namespace boost {
  template <class Y> class shared_ptr;
}

namespace uhal
{
  class HwInterface
  {
    public:
      HwInterface ( const boost::shared_ptr<ClientInterface>& aClientInterface , const boost::shared_ptr< Node >& aNode );

      HwInterface ( const HwInterface& hwInterface );

      virtual ~HwInterface();

      ClientInterface& getClient();

      std::string uri() const;

      const std::string& id() const;


      void dispatch ();

      void setTimeoutPeriod ( const uint32_t& aTimeoutPeriod );

      uint32_t getTimeoutPeriod();

      // /**
      // Ping the target for this client
      // */
      // void ping();

      const Node& getNode () const;

      const Node& getNode ( const std::string& aId ) const;

      template< typename T>
      const T& getNode ( const std::string& aId ) const;


      std::vector<std::string> getNodes() const;

      std::vector<std::string> getNodes ( const std::string& aRegex ) const;

      // /**
      // Get the target device's reserved address information
      // @return a Validated Memory which wraps the location to which the reserved address information will be written
      // */
      // ValVector< uint32_t > readReservedAddressInfo ();

    private:
      void claimNode ( Node& aNode );

      boost::shared_ptr<ClientInterface> mClientInterface;

      boost::shared_ptr<Node> mNode;

  };

}

#include "uhal/TemplateDefinitions/HwInterface.hxx"

#endif