modbus_io.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_MODBUS_IO_H
#define AUBO_SCOPE_MODBUS_IO_H
 
#include <aubo_caps/domain/io/io.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ModbusIo);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * Modbus IO 接口
 * 此接口提供对 MODBUS I/O 的支持。
 * \endchinese
 * \english
 * ModbusIo
 * This interface provides support for MODBUS I/Os.
 * \endenglish
 */
class ARCS_ABI_EXPORT ModbusIo : public Io
{
public:
    ModbusIo(ModbusIo &f);
    ModbusIo(ModbusIo &&f);
    ~ModbusIo();
 
    /**
     * @ingroup ModbusIo
     * \chinese
     * 获取此MODBUS I/O的IP地址
     * @return IP地址。
     * \endchinese
     * \english
     * Returns the IP address for this MODBUS I/O.
     * @return Get the IP address for this MODBUS I/O.
     * \endenglish
     */
    std::string getIpAddress();
 
    /**
     * @ingroup ModbusIo
     * \chinese
     * 获取此MODBUS I/O的信号地址
     * @return 信号地址。
     * \endchinese
     * \english
     * Returns the signal address for this MODBUS I/O.
     * @return the signal address for this MODBUS I/O.
     * \endenglish
     */
    std::string getSignalAddress();
 
    /**
     * @ingroup ModbusIo
     * \chinese
     * 判断此MODBUS I/O是否为从站
     * @return 是否为从站。
     * \endchinese
     * \english
     * Returns whether this MODBUS I/O is a slave.
     * @return Get the is slave for this MODBUS I/O.
     * \endenglish
     */
    bool isSlave();
 
    /**
     * @ingroup ModbusIo
     * \chinese
     * 设置MODBUS信号的整数值。
     * @param value 要设置的整数值。
     * @return 信号下发成功返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * Set MODBUS signal to an integer value.
     * @param value Set MODBUS signal to an integer value.
     * @return <code>true</code> if the MODBUS signal was sent down to the
     * controller, and <code>false</code> if the signal was not sent down.
     * \endenglish
     */
    bool setValue(int value);
 
    /**
     * @ingroup ModbusIo
     * \chinese
     * 获取MODBUS信号的整数值。
     * @return MODBUS信号的整数值。
     * \endchinese
     * \english
     * Returns the integer value of the MODBUS signal.
     * @return the integer value of the MODBUS signal.
     * \endenglish
     */
    int getValue();
 
private:
    friend class DataSwitch;
    ModbusIo();
    void *d_{ nullptr };
};
 
struct ModbusIoFilter
{
    ModbusIoFilter(Io::IoType type, bool is_input)
        : type_(type), is_input_(is_input)
    {
    }
    bool operator()(IoPtr io)
    {
        return std::dynamic_pointer_cast<ModbusIo>(io) != nullptr &&
               io->getType() == type_ && io->isInput() == is_input_;
    }
 
private:
    Io::IoType type_;
    bool is_input_;
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // MODBUSIO_H