r2000_driver.h

Go to the documentation of this file.

// Copyright (c) 2014, Pepperl+Fuchs GmbH, Mannheim
// Copyright (c) 2014, Denis Dillenberger
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
//   list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice, this
//   list of conditions and the following disclaimer in the documentation and/or
//   other materials provided with the distribution.
//
// * Neither the name of Pepperl+Fuchs nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef R2000_DRIVER_H
#define R2000_DRIVER_H

#include <string>
#include <vector>
#include <map>
#include <boost/optional.hpp>
#include <pepperl_fuchs_r2000/protocol_info.h>
#include <pepperl_fuchs_r2000/packet_structure.h>

namespace pepperl_fuchs {

class HttpCommandInterface;
class ScanDataReceiver;

class R2000Driver
{
public:
    R2000Driver();

    ~R2000Driver();

    bool connect(const std::string hostname, int port=80);

    void disconnect();

    bool isConnected() {return is_connected_; }

    bool startCapturingTCP();

    bool startCapturingUDP();

    bool stopCapturing();

    bool isCapturing();

    bool checkConnection();

    const ProtocolInfo& getProtocolInfo() { return protocol_info_; }

    const std::map< std::string, std::string >& getParameters();

    const std::map< std::string, std::string >& getParametersCached() const {return parameters_;}

    ScanData getScan();

    ScanData getFullScan();

    std::size_t getScansAvailable() const;

    std::size_t getFullScansAvailable() const;

    bool setScanFrequency( unsigned int frequency );

    bool setSamplesPerScan( unsigned int samples );

    bool rebootDevice();

    bool resetParameters( const std::vector<std::string>& names );

    bool setParameter( const std::string& name, const std::string& value );

    void feedWatchdog(bool feed_always = false);

private:
    HttpCommandInterface* command_interface_;

    ScanDataReceiver* data_receiver_;

    bool is_connected_;

    bool is_capturing_;

    double watchdog_feed_time_;

    double food_timeout_;

    boost::optional<HandleInfo> handle_info_;

    ProtocolInfo protocol_info_;

    std::map< std::string, std::string > parameters_;
};

} // NS pepperl_fuchs

#endif // R2000_DRIVER_H