io_model.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_IO_MODEL_H
#define AUBO_SCOPE_IO_MODEL_H
 
#include <vector>
#include <functional>
#include <aubo_caps/class_forward.h>
#include <aubo_caps/domain/io/io.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(IoModel);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * IO 模型
 * 提供从当前机器人安装中获取 I/O 的方法。
 * \endchinese
 * \english
 * IoModel
 * Provides methods that returns I/Os from the current robot installation.
 * \endenglish
 */
class ARCS_ABI_EXPORT IoModel
{
public:
    IoModel(IoModel &f);
    IoModel(IoModel &&f);
    ~IoModel();
 
    /**
     * @ingroup IoModel
     * \chinese
     * 获取所有可用的I/O集合
     * @return 可用I/O的集合。
     * \endchinese
     * \english
     * Returns the collection of available I/Os, including Modbus, EuroMap67 and
     * named General Purpose Registers.
     * @return the collection of available I/Os.
     * \endenglish
     */
    std::vector<IoPtr> getAll();
 
    /**
     * @ingroup IoModel
     * @ref Io
     * \chinese
     * 根据名称获取I/O
     * @param name I/O名称。
     * @return 对应名称的I/O。
     * \endchinese
     * \english
     * Get an I/O by name.
     * @param name the name of the I/O.
     * @return the I/O with the given name.
     * \endenglish
     */
    IoPtr getIo(const std::string &name);
 
    /**
     * @ingroup IoModel
     * \chinese
     * 使用过滤器获取I/O子集
     * @param filter 过滤器。
     * @return 被过滤器接受的I/O集合。
     * \endchinese
     * \english
     * Get a subset of I/Os using a filter.
     * @param filter see {@link IOFilterFactory}.
     * @return the collection of IOs that are accepted by the filter.
     * \endenglish
     */
    std::vector<IoPtr> getIos(std::function<bool(IoPtr)> filter);
 
private:
    friend class DataSwitch;
    IoModel();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
#endif