ethernet_ip.h

Go to the documentation of this file.

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