variable_factory.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_VARIABLE_FACTORY_H
#define AUBO_SCOPE_VARIABLE_FACTORY_H
 
#include <aubo_caps/domain/value/expression/expression.h>
#include <aubo_caps/domain/variable/global_variable.h>
#include <aubo_caps/domain/variable/feature_variable.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(VariableFactory);
 
/**
 * @ingroup ApplicationApi
 * <p>
 * This interface supplies methods to create variable objects.
 * </p>
 *
 * <b>NOTE:</b> Only use this functionality in a AuboCap program node (not
 * relevant for an installation node).
 */
class ARCS_ABI_EXPORT VariableFactory
{
public:
    VariableFactory(VariableFactory &f);
    VariableFactory(VariableFactory &&f);
    ~VariableFactory();
 
    /**
     * @ingroup VariableFactory
     * \chinese
     * <p>
     * 创建全局变量。在AuboScope中注册后将对所有程序节点可见。
     * </p>
     * @param suggested_name 建议的变量名称。
     * @return GlobalVariable。
     * @throws VariableException 名称非法时抛出。
     * \endchinese
     * \english
     * <p>
     * Creates a global variable. Registering the variable in AuboScope (by
     * storing it in a {@link DataModel} instance or using it for the
     * configuration of a built-in AuboScope program node) will make it
     * accessible to all program nodes.
     * </p>
     *
     * @param suggested_name Suggested name of the variable.
     * @return GlobalVariable.
     * @throws VariableException In case of an illegal name.
     * \endenglish
     */
    GlobalVariablePtr createGlobalVariable(const std::string &suggested_name);
 
    /**
     * @ingroup VariableFactory
     * \chinese
     * <p>创建带初始值的全局变量。</p>
     * @param suggested_name 建议的变量名称。
     * @param initialValue 初始化表达式。
     * @return GlobalVariable。
     * \endchinese
     * \english
     * <p>
     * Creates a global variable with an initial value.
     * </p>
     * @param suggested_name Suggested name of the variable.
     * @param initialValue The expression that will be evaluated in order to
     * initialize the value of the variable.
     * @return GlobalVariable.
     * @throws VariableException In case of an illegal name.
     * \endenglish
     */
    GlobalVariablePtr createGlobalVariable(const std::string &suggested_name,
                                           ExpressionPtr initialValue);
 
    /**
     * @ingroup VariableFactory
     * \chinese
     * <p>创建特征变量。</p>
     * @param suggested_name 建议的变量名称。
     * @param pose 特征的位姿。
     * @return FeatureVariable。
     * @throws VariableException 名称非法时抛出。
     * \endchinese
     * \english
     * <p>
     * Creates a feature variable.
     * </p>
     * @param suggested_name Suggested name of the variable.
     * @param pose the pose of the feature.
     * @return FeatureVariable.
     * @throws VariableException In case of an illegal name.
     * \endenglish
     */
    FeatureVariablePtr createFeatureVariable(const std::string &suggested_name,
                                             const std::vector<double> &pose);
 
private:
    friend class DataSwitch;
    VariableFactory();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
#endif // AUBO_SCOPE_VARIABLE_FACTORY_H