function_model.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_FUNCTION_MODEL_H
#define AUBO_SCOPE_FUNCTION_MODEL_H
 
#include <aubo_caps/domain/function/function.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(FunctionModel);
 
/**
 * @ingroup InstallationApi
 * \chinese
 * 函数模型
 * 此接口提供在表达式编辑器中添加和删除脚本函数的方法，该编辑器可从赋值和 If
 * 程序节点等位置访问。
 *
 * 添加的函数仅为终端用户提供了一种便捷的方式来使用贡献的函数。特定脚本函数的实现
 * 必须通过 {@link InstallationNodeContribution#generateScript(ScriptWriter)}
 * 添加到程序的前导部分。
 *
 * 所有可贡献的函数都必须始终添加到前导部分，无论它们是否被添加到表达式编辑器中。
 * 否则，依赖脚本函数贡献的旧程序可能会停止工作。
 *
 * 另请参见 {@link Function}。
 * \endchinese
 * \english
 * FunctionModel
 * This interface provides methods to add and remove script functions in the
 * Expression Editor accessible from Assignment and If program nodes among
 * others.
 *
 * Added functions merely serve as an easy way for the end customer to use the
 * contributed functions. The implementation of a given script function must be
 * added in the preamble of program through the use of
 * {@link InstallationNodeContribution#generateScript(ScriptWriter)}.
 *
 * The full set of functions which can be contributed must be added in the
 * preamble at all times, regardless of whether they are added to the Expression
 * Editor or not. Otherwise old programs that rely on a script function
 * contribution might stop working.
 *
 * See also {@link Function}.
 * \endenglish
 */
class ARCS_ABI_EXPORT FunctionModel
{
public:
    FunctionModel(FunctionModel &f);
    FunctionModel(FunctionModel &&f);
    ~FunctionModel();
 
    /**
     * \chinese
     * 添加脚本函数到表达式编辑器。
     * @param name 函数名称。有效名称必须匹配正则表达式[a-zA-Z][a-zA-Z0-9_]{0,24}，
     * 共25个字符。部分AUBO Robot保留名称不可使用。
     * @param argumentNames 函数参数提示列表，在表达式编辑器中以逗号分隔显示在尖括号
     * 内。最多指定五个参数。
     * @return 成功添加返回表示函数的对象，否则返回null。
     * @throws FunctionException 如果名称非法或指定了超过五个参数。
     * \endchinese
     * \english
     * Add a script function to the Expression Editor.
     * @param name Name of the function. Safe names must match regex
     * [a-zA-Z][a-zA-Z0-9_]{0,24} for a total of 25 characters.
     * @param argumentNames Is a list of hints for the function arguments.
     * @return If the script function was successfully added, an object
     * representing the Function will be returned. Null otherwise.
     * @throws FunctionException if the name is illegal or more than five
     * arguments are specified.
     * \endenglish
     */
    FunctionPtr addFunction(const std::string &name,
                            const std::vector<std::string> &argumentNames);
 
    /**
     * \chinese
     * 移除函数。只能移除此AuboCap添加的函数。
     * @param function 要移除的函数。
     * @return 成功移除返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * Remove a function. Only functions added by this AuboCap can be removed.
     * @param function Function to be removed.
     * @return <code>true</code>, if the function was successfully removed.
     * \endenglish
     */
    bool removeFunction(FunctionPtr func);
 
    /**
     * \chinese
     * 根据名称获取函数
     * @param name 函数名称。
     * @return 找到返回函数，否则返回null。
     * \endchinese
     * \english
     * Get a function by name.
     * @param name The name of the function.
     * @return The function if found, otherwise null.
     * \endenglish
     */
    FunctionPtr getFunction(const std::string &name);
 
    /**
     * \chinese
     * 获取所有已添加的函数
     * @return 已添加函数的集合。
     * \endchinese
     * \english
     * Get all added functions.
     * @return A collection of added functions.
     * \endenglish
     */
    std::vector<FunctionPtr> getFunctions();
 
private:
    friend class DataSwitch;
    FunctionModel();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_FUNCTION_MODEL_H