/home/breidi/Dropbox/signalserver/include/hardware/hw_thread.h

Go to the documentation of this file.

/*
    This file is part of the TOBI SignalServer.

    Commercial Usage
    Licensees holding valid Graz University of Technology Commercial
    licenses may use this file in accordance with the Graz University
    of Technology Commercial License Agreement provided with the
    Software or, alternatively, in accordance with the terms contained in
    a written agreement between you and Graz University of Technology.

    --------------------------------------------------

    GNU General Public License Usage
    Alternatively, this file may be used under the terms of the GNU
    General Public License version 3.0 as published by the Free Software
    Foundation and appearing in the file gpl.txt included in the
    packaging of this file.  Please review the following information to
    ensure the GNU General Public License version 3.0 requirements will be
    met: http://www.gnu.org/copyleft/gpl.html.

    In case of GNU General Public License Usage ,the TOBI SignalServer
    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 the TOBI SignalServer. If not, see <http://www.gnu.org/licenses/>.

    Copyright 2010 Graz University of Technology
    Contact: SignalServer@tobi-project.org
*/

#ifndef HWThread_H
#define HWThread_H

#define SLAVE       0
#define MASTER      1
#define APERIODIC   2

#include <map>
#include <string>

#include <boost/thread.hpp>
#include <boost/cstdint.hpp>

#include "ticpp/ticpp.h"

#include "tia/defines.h"
#include "sampleblock/sample_block.h"

namespace tobiss
{

//-----------------------------------------------------------------------------

class HWThread
{
  public:

    virtual ~HWThread()
    {    }

    std::string getType()  { return(type_); }

    bool isMaster()   { return(mode_ == MASTER); }

    bool isSlave()   { return(mode_ == SLAVE); }

    bool isAperiodic()   { return(mode_ == APERIODIC); }

    bool hasHomogenousSignalType()  { return(homogenous_signal_type_); }

    boost::uint16_t getNrOfBlocks()    { return(blocks_); }
    double getSamplingRate()  { return(fs_); }
    boost::uint16_t getNrOfChannels()  { return(nr_ch_); }
    std::vector<boost::uint32_t> getChannelTypes()  { return(channel_types_); }
    std::map<boost::uint16_t, std::pair<std::string, boost::uint32_t> > getChannelInfoMap()  { return(channel_info_); }
    bool samplesAvailable();
    void checkMandatoryHardwareTags(ticpp::Iterator<ticpp::Element> hw);

    virtual SampleBlock<double> getSyncData() = 0;
    virtual SampleBlock<double> getAsyncData() = 0;
    virtual void run() = 0;

    virtual void stop() = 0;

  protected:

    HWThread(boost::uint32_t sampling_rate, boost::uint16_t channels, boost::uint16_t blocks)
    : nr_ch_(channels),fs_(sampling_rate), samples_available_(0), blocks_(blocks),
    mode_(SLAVE), running_(0)
    {    }

    HWThread()
    : nr_ch_(0),fs_(0), samples_available_(0), blocks_(1), mode_(SLAVE), running_(0)
    {    }

    virtual void setDeviceSettings(ticpp::Iterator<ticpp::Element>const &father) = 0;
    virtual void setChannelSettings(ticpp::Iterator<ticpp::Element>const &father) = 0;


    void setSamplingRate(ticpp::Iterator<ticpp::Element>const &elem);
    void setDeviceChannels(ticpp::Iterator<ticpp::Element>const &elem);
    void setBlocks(ticpp::Iterator<ticpp::Element>const &elem);
    void setChannelSelection(ticpp::Iterator<ticpp::Element>const &elem);
    void setChannelTypes();

    bool isNumber(const std::string& s)
    {
      for (unsigned int i = 0; i < s.length(); i++)
        if (!isdigit(s[i]))
          return false;
      return true;
    }
    void setType(std::string s)
    {
      type_ = s;
    }

    boost::uint16_t getChannelPosition(boost::uint16_t ch_nr)
    {
      unsigned int n = 0;
      for(std::map<boost::uint16_t, std::pair<std::string, boost::uint32_t> >::iterator it(channel_info_.begin());
          it != channel_info_.end(); it++)
      {
        if(it->first == ch_nr)
          break;
        n++;
      }
      if(n > channel_info_.size())
        throw(std::runtime_error("HWThread::getChannelPosition -- Channel not found in channel_info!"));

      return(n);
    }

//-----------------------------------------------

  protected:
    boost::uint16_t nr_ch_;   
    double fs_;      
    bool samples_available_;
    boost::uint16_t blocks_;   
    boost::uint8_t mode_;       
    bool running_;      

    boost::shared_mutex rw_;     

    std::map<boost::uint16_t, std::pair<std::string, boost::uint32_t> > channel_info_;  
    bool homogenous_signal_type_;  
    std::vector<boost::uint32_t> channel_types_;   

    SampleBlock<double> data_;

    std::string   type_;


    //-----------------------------------------------
    // Constant variables & methods:

    static const std::string hardware_version_;
    static const std::string hardware_serial_;

    static const std::string hw_mode_;
    static const std::string hw_devset_;        
    static const std::string hw_fs_;            

    static const std::string hw_channels_;      
    static const std::string hw_ch_nr_;         
    static const std::string hw_ch_names_;      
    static const std::string hw_ch_type_;       

    static const std::string hw_blocksize_;     

    static const std::string hw_chset_;       
    static const std::string hw_chset_sel_;           
    static const std::string hw_chset_ch_;      
    static const std::string hw_chset_nr_;     
    static const std::string hw_chset_name_;   


    //---------------------------------------------------------------------------------------

    bool equalsOnOrOff(const std::string& s);
    bool equalsYesOrNo(const std::string& s);
    bool equalsMaster(const std::string& s);
    bool equalsSlave(const std::string& s);
    bool equalsAperiodic(const std::string& s);
//    uint32_t getSignalFlag(const std::string& s);
//    std::string getSignalName(const boost::uint32_t& flag);

    void parseDeviceChannels(ticpp::Iterator<ticpp::Element>const &elem, boost::uint16_t& nr_ch,
                                 std::string& naming, std::string& type);

    void parseChannelSelection(ticpp::Iterator<ticpp::Element>const &elem, boost::uint16_t& ch,
                                   std::string& name, std::string& type);

    void checkMandatoryHardwareTagsXML(ticpp::Iterator<ticpp::Element> hw);


};

} // Namespace tobiss

#endif // HWThread_H

//-----------------------------------------------------------------------------