variable_model.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_VARIABLE_MODEL_H
#define AUBO_SCOPE_VARIABLE_MODEL_H
 
#include <vector>
#include <functional>
#include <aubo_caps/domain/feature/feature.h>
#include <aubo_caps/domain/variable/variable_factory.h>
#include <aubo_caps/domain/variable/feature_variable.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(VariableModel);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * 变量模型
 * 提供返回系统中当前已注册变量的方法。变量在存储到 {@link DataModel} 实例中或
 * 用于配置内置 AuboScope 程序节点时即被注册。
 * \endchinese
 * \english
 * VariableModel
 * Provides methods that returns the variables that currently are registered in
 * the system. A variable is registered if it has been stored in a {@link
 * DataModel} instance or used for the configuration of a built-in AuboScope
 * program node.
 * \endenglish
 */
class ARCS_ABI_EXPORT VariableModel
{
public:
    VariableModel(VariableModel &f);
    VariableModel(VariableModel &&f);
    ~VariableModel();
 
    /**
     * @ingroup VariableModel
     * \chinese
     * 获取系统中当前已注册的所有变量
     * @return 已注册变量的集合。
     * \endchinese
     * \english
     * Returns the collection of all variables that currently are registered in
     * the system.
     * @return the collection of all registered variables.
     * \endenglish
     */
    std::vector<VariablePtr> getAll();
 
    VariablePtr get(const std::string &name);
 
    /**
     * @ingroup VariableModel
     * \chinese
     * 使用过滤器获取已注册变量的子集
     * @param filter 过滤器。
     * @return 被过滤器接受的变量集合。
     * \endchinese
     * \english
     * Get a subset of all the variables registered in the system using a filter.
     *
     * @param filter see {@link VariableFilterFactory} for examples.
     * @return the collection of Variables that are accepted by the filter.
     * \endenglish
     */
    std::vector<VariablePtr> get(std::function<bool(VariablePtr)> filter =
                                     [](VariablePtr) { return true; });
 
    /**
     * @ingroup VariableModel
     * \chinese
     * 获取变量工厂，用于创建变量对象
     * @return 变量工厂。
     * \endchinese
     * \english
     * Returns a {@link VariableFactory} to create variable objects.
     * @return a {@link VariableFactory} to create variable objects.
     * \endenglish
     */
    VariableFactoryPtr getVariableFactory();
 
    /**
     * @ingroup VariableModel
     * \chinese
     * 获取特征对应的特征变量
     * @param feature 带有变量的特征。
     * @return 特征的变量。
     * @throws IllegalArgumentException 如果特征不在安装中或特征没有变量。
     * \endchinese
     * \english
     * Get the feature variable for a {@link Feature}.
     *
     * @param feature the feature with a variable.
     * @return the variable for the feature.
     * @throws IllegalArgumentException If feature not is present in the
     * installation or feature has no variable, see {@link Feature#isVariable()}.
     * \endenglish
     */
    FeatureVariablePtr getFeatureVariable(FeaturePtr feature);
 
    /**
     * @ingroup VariableModel
     * \chinese
     * 注册变更回调
     * @param receiver 接收者标识。
     * @param slot 回调函数。
     * @return 连接标识符。
     * \endchinese
     * \english
     * Register callback for changed.
     *
     * @param receiver the receiver identifier.
     * @param slot the callback function.
     * @return the connection identifier.
     * \endenglish
     */
    std::string connectedTo(const std::string &receiver,
                            const std::function<void(VariableModel *)> &slot);
    /**
     * @ingroup VariableModel
     * \chinese
     * 断开回调连接
     * @param receiver 接收者标识。
     * \endchinese
     * \english
     * Disconnect a callback.
     * @param receiver the receiver identifier.
     * \endenglish
     */
    void disconnectFrom(const std::string &receiver);
 
private:
    friend class DataSwitch;
    VariableModel();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
#endif // AUBO_SCOPE_VARIABLE_MODEL_H