profinet.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_PROFINET_H
#define AUBO_SCOPE_PROFINET_H
 
#include <aubo_caps/domain/io/io.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(Profinet);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * PROFINET IO 接口
 * 此接口提供对 PROFINET I/O 的支持。
 * \endchinese
 * \english
 * Profinet
 * This interface provides support for PROFINET I/Os.
 * \endenglish
 */
class ARCS_ABI_EXPORT Profinet : public Io
{
public:
    Profinet(Profinet &f);
    Profinet(Profinet &&f);
    ~Profinet();
 
    /**
     * @ingroup Profinet
     * \chinese
     * 获取此PROFINET I/O的字节偏移量
     * @return 字节偏移量。
     * \endchinese
     * \english
     * Returns the byte offset for this Profinet I/O.
     * @return Get the byte offset for this Profinet I/O.
     * \endenglish
     */
    int getByteOffset();
 
    /**
     * @ingroup Profinet
     * \chinese
     * 获取此PROFINET I/O的位偏移量
     * @return 位偏移量。
     * \endchinese
     * \english
     * Returns the bit offset for this Profinet I/O.
     * @return Get the bit offset for this Profinet I/O.
     * \endenglish
     */
    int getBitOffset();
 
    /**
     * @ingroup Profinet
     * \chinese
     * 判断此PROFINET I/O是否为从站
     * @return 是否为从站。
     * \endchinese
     * \english
     * Returns whether this Profinet I/O is a slave.
     * @return <code>true</code> if this is a slave.
     * \endenglish
     */
    bool isSlave();
 
    /**
     * @ingroup Profinet
     * \chinese
     * 设置PROFINET信号的整数值。如果PROFINET信号是数字量，则<code>false</code>用0
     * 表示，<code>true</code>用所有非0数字表示。
     *
     * @param value 要设置的整数值。
     * @return 如果PROFINET信号已下发到控制器则返回<code>true</code>，如果信号未下发
     * （例如控制器未运行）则返回<code>false</code>。注意PROFINET信号必须支持写入，
     * 请查阅Aubo PROFINET协议。
     * \endchinese
     * \english
     * Set PROFINET signal to an integer value. If the PROFINET signal is
     * digital, then <code>false</code> is represented by 0 and
     * <code>true</code> are represented by all numbers different from 0.
     *
     * @param value the integer value to set.
     * @return <code>true</code> if the PROFINET signal was sent down to the
     * controller, and <code>false</code> if the signal was not sent down, e.g.
     * because the controller was not running. Notice that the PROFINET signal
     * must support writes, consult the Aubo PROFINET protocol.
     * \endenglish
     */
    bool setValue(int value);
 
    /**
     * @ingroup Profinet
     * \chinese
     * 获取PROFINET信号的整数值。如果PROFINET信号是数字量，则<code>false</code>用0
     * 表示，<code>true</code>用值1表示。
     * @return PROFINET信号的整数值。
     * \endchinese
     * \english
     * Returns the integer value of the PROFINET signal. If the PROFINET signal
     * is digital then <code>false</code> is represented by 0 and
     * <code>true</code> is represented by the value 1.
     * @return the integer value of the PROFINET signal.
     * \endenglish
     */
    int getValue();
 
private:
    friend class DataSwitch;
    Profinet();
    void *d_{ nullptr };
};
 
struct ProfinetFilter
{
    ProfinetFilter(Io::IoType type, bool is_input)
        : type_(type), is_input_(is_input)
    {
    }
    bool operator()(IoPtr io)
    {
        return std::dynamic_pointer_cast<Profinet>(io) != nullptr &&
               io->getType() == type_ && io->isInput() == is_input_;
    }
 
private:
    Io::IoType type_;
    bool is_input_;
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // PROFINETIO_H