io.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_IO_H
#define AUBO_SCOPE_IO_H
 
#include <string>
#include <aubo_caps/class_forward.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(Io);
 
/**
 * \chinese
 * IO 基础接口
 * 这是表示 AuboScope 中所有可用 I/O 类型的基础接口。
 * \endchinese
 * \english
 * Io
 * This is the base interface representing all types of I/Os available in
 * AuboScope.
 * \endenglish
 */
class ARCS_ABI_EXPORT Io
{
public:
    enum IoType : int
    {
        DIGITAL,
        ANALOG,
        INTEGER,
        BOOLEAN,
        DOUBLE
    };
    enum InterfaceType : int
    {
        STANDARD,
        TOOL,
        CONFIGURABLE,
        LINKIO,
        MODBUS,
        GENERAL_PURPOSE,
        PROFINET,
        ETHERNET_IP,
    };
 
public:
    Io(Io &f);
    Io(Io &&f);
    virtual ~Io();
 
    /**
     * \chinese
     * 获取当前安装中I/O的用户自定义名称
     * @return I/O的显示名称。
     * \endchinese
     * \english
     * Returns the user defined name of the IO in the currently selected
     * installation.
     * @return the user defined name of the IO.
     * \endenglish
     */
    std::string getDisplayName() const;
 
    /**
     * \chinese
     * 获取I/O的机器人默认名称
     * @return I/O的默认名称。
     * \endchinese
     * \english
     * Returns the robot default name of the I/O.
     * @return the robot default name of the I/O.
     * \endenglish
     */
    std::string getDefaultName() const;
 
    /**
     * \chinese
     * 获取I/O的当前读数值（字符串形式）
     * @return I/O的当前读数。
     * \endchinese
     * \english
     * Returns the current reading of the I/O as a string.
     * @return get current reading of the I/O as a string.
     * \endenglish
     */
    std::string getValueStr() const;
 
    /**
     * \chinese
     * 获取I/O类型
     * @return I/O类型枚举。
     * \endchinese
     * \english
     * Returns the I/O type.
     * @return the I/O type.
     * \endenglish
     */
    IoType getType() const;
 
    /**
     * \chinese
     * 获取此I/O所属的接口类型
     * @return 接口类型枚举。
     * \endchinese
     * \english
     * Returns the interface type this I/O belongs to.
     * @return the interface type this I/O belongs to.
     * \endenglish
     */
    InterfaceType getInterfaceType() const;
 
    /**
     * \chinese
     * 获取I/O的动作编号
     * @return I/O的动作编号。
     * \endchinese
     * \english
     * Returns the action number of the I/O.
     * @return the action number of the I/O.
     * \endenglish
     */
    int getAction() const;
 
    /**
     * \chinese
     * 判断I/O是否支持读取值
     * @return 如果I/O支持读取返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * Returns <code>true</code> if I/O supports reading of values and
     * <code>false</code> otherwise.
     * @return <code>true</code> if I/O supports reading of values.
     * \endenglish
     */
    bool isInput() const;
 
    /**
     * \chinese
     * 某些I/O（如MODBUS I/O和模拟工具输入）在某些情况下可能不可用。此方法用于判断
     * I/O是否可用。
     * @return 如果I/O可解析返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * Some I/Os, such as MODBUS I/Os and analog Tool inputs, are in some
     * situations not present in AuboScope or available for use. This method can
     * be used to determine if the I/O is available.
     * @return <code>true</code>, if I/O can be resolved.
     *         <code>false</code> otherwise.
     * \endenglish
     */
    bool isResolvable() const;
 
    size_t hashCode();
 
protected:
    Io();
 
private:
    friend class DataSwitch;
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_IO_H