function.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_FUNCTION_H
#define AUBO_SCOPE_FUNCTION_H
 
#include <vector>
#include <aubo_caps/domain/extension_info.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(Function);
 
/**
 * \chinese
 * 函数接口
 * 表示在表达式编辑器中显示的函数。
 *
 * 另请参见 {@link FunctionModel}。
 * \endchinese
 * \english
 * Function
 * Represents a function shown in the Expression Editor.
 *
 * See also {@link FunctionModel}.
 * \endenglish
 */
class ARCS_ABI_EXPORT Function
{
public:
    Function(Function &f);
    Function(Function &&f);
    ~Function();
 
    /**
     * \chinese
     * 获取函数名称
     * @return 函数名称。
     * \endchinese
     * \english
     * Returns the name of the function.
     * @return The name of the function.
     * \endenglish
     */
    std::string getName();
 
    /**
     * \chinese
     * 获取函数参数列表
     * @return 函数参数列表。
     * \endchinese
     * \english
     * Returns a list of the arguments of the function.
     * @return A list of the arguments of the function.
     * \endenglish
     */
    std::vector<std::string> getArguments();
 
    /**
     * \chinese
     * 获取将此函数添加/贡献到AuboScope的AuboCap信息。
     * @return 此函数的AuboCap信息。
     * \endchinese
     * \english
     * Get information about the AuboCap that added/contributed this function
     * to AuboScope.
     *
     * @return AuboCap information for this function.
     * \endenglish
     */
    AuboCapInfoPtr getContributorInfo();
 
private:
    friend class DataSwitch;
    Function();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_FUNCTION_H