comAdptEnvision.hpp

Go to the documentation of this file.

 
#ifndef CCF_PROTOCOLS_COM_ADPT_ENVISION_LLNETIO_HPP_H_
#define CCF_PROTOCOLS_COM_ADPT_ENVISION_LLNETIO_HPP_H_
 
#include "ifw/ccf/protocols/envision_llnetio/opcuaClientWrapper.hpp"
 
#include <ifw/ccf/protocols/rtms_llnetio/comAdptRtms.hpp>
 
 
namespace ifw::ccf::protocols::envision_llnetio {
 
    constexpr auto DEV_PROP_OPCUA_OBJECT     = "OpcUaObject";
    constexpr auto DEV_PROP_OPCUA_NS         = "OpcUaNs";

  class ComAdptEnvision: public ifw::ccf::protocols::rtms_llnetio::ComAdptRtms {
  public:
 
    ComAdptEnvision();
    virtual ~ComAdptEnvision();

    virtual void InitialiseUser();

    virtual void SetDeviceAddressUser(const std::string& address);

    virtual void CheckConnectionUser(bool& connected);

    virtual void CheckStatusUser(ifw::ccf::HwStatus& status,
                                 std::string& message);

    virtual void ConnectUser();

    virtual void DisconnectUser();

    virtual void ReceiveUser(ifw::ccf::common::DataFrame& frame,
                             bool& frame_received,
                             const double timeout,
                             bool& timed_out);

    virtual void ReadUser(const std::string& name,
                          ifw::core::utils::param::Parameter& par);

    virtual void ScanUser(std::vector<ifw::core::utils::param::Parameter>& pars);

    virtual void StartUser();

    virtual void StopUser();

    virtual void WriteUser(const ifw::core::utils::param::Parameter& par);

    virtual void HandleParPreWriteUser(ifw::core::utils::param::Parameter& par);

    virtual void HandleParPostWriteUser(ifw::core::utils::param::Parameter& par);

    virtual void HandleParPostReadUser(ifw::core::utils::param::Parameter& par);

    virtual void HandleSetupUser();
 
  protected:
 
  private:
 
    void CheckErrTryReconnect(const std::string& action,
                              const std::string& err);
 
    void WriteOpcUa(const ifw::core::utils::param::Parameter& par);
 
    void CoreParToPairVariant(const ifw::core::utils::param::Parameter& par,
                              ifw::core::protocol::base::PairVariant& variant_par,
                              ifw::fnd::datatype::DataType& data_type);

    ifw::fnd::datatype::DataType GetNodeType(const std::string& low_level_name);
 
    OpcuaClientWrapper  m_opcua_client;
 
    // Name of object in OPC UA namespace, hosting the nodes for the device.
    std::string m_opcua_object;
 
    // Cache in which node values are updated to get access to the type.
    std::map<std::string, ifw::core::protocol::base::Variant> m_nodes_cache;
 
    // Cache for node data types.
    std::map<std::string, ifw::fnd::datatype::DataType> m_node_types_cache;
 
    std::string         m_opcua_ns;
 
    double              m_expo_time;
 
    // Set to true when running (started), false when stopped.
    std::atomic<bool>   m_dev_acq_running{false};
  };
 
}
 
#endif // CCF_PROTOCOLS_COM_ADPT_ENVISION_LLNETIO_HPP_H_