analog_io.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_ANALOG_IO_H
#define AUBO_SCOPE_ANALOG_IO_H
 
#include <aubo_caps/domain/io/io.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(AnalogIo);
 
/**
 * \chinese
 * 模拟 IO 接口
 * 此接口提供对模拟 I/O 的支持。
 * \endchinese
 * \english
 * AnalogIo
 * This interface provides support for analog I/Os.
 * \endenglish
 */
class ARCS_ABI_EXPORT AnalogIo : public Io
{
public:
    AnalogIo(AnalogIo &f);
    AnalogIo(AnalogIo &&f);
    ~AnalogIo();
 
    double getMinRangeValue();
    double getMaxRangeValue();
 
    bool isCurrent();
    bool isVoltage();
 
    /**
     * \chinese
     * 设置模拟I/O输出信号。注意该I/O必须是输出类型。
     * @param value 要设置的模拟值。
     * @return 如果模拟信号设置成功返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * Set analog I/O output signal. Notice the I/O must be an output I/O.
     *
     * @param value The analog value to be set.
     * @return <code>true</code> if the analog signal was set,
     * <code>false</code> if the signal was not set, e.g. because the controller
     * was not running.
     * \endenglish
     */
    bool setValue(double value);
 
    /**
     * \chinese
     * 获取I/O的最后一次读数
     * @return I/O的最后一次读数。
     * \endchinese
     * \english
     * Returns the last reading of the I/O.
     * @return Returns the last reading of the I/O.
     * \endenglish
     */
    double getValue();
 
private:
    friend class DataSwitch;
    AnalogIo();
    void *d_{ nullptr };
};
 
struct AnalogIoFilter
{
    AnalogIoFilter(Io::InterfaceType interface, bool is_input)
        : interface_(interface), is_input_(is_input)
    {
    }
    bool operator()(IoPtr io)
    {
        return std::dynamic_pointer_cast<AnalogIo>(io) != nullptr &&
               io->getInterfaceType() == interface_ &&
               io->isInput() == is_input_;
    }
 
private:
    Io::InterfaceType interface_;
    bool is_input_;
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_ANALOG_IO_H