contribution_provider.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_CONTRIBUTION_PROVIDER_H
#define AUBO_SCOPE_CONTRIBUTION_PROVIDER_H
 
#include <memory>
#include <aubo_caps/contribution/program/program_node_contribution.h>
 
namespace arcs {
namespace aubo_scope {
 
/**
 * \chinese
 * 贡献提供者
 * 此接口提供对贡献的访问。
 *
 * 注意：此接口不适用于具有基于 HTML 用户界面的贡献。
 *
 * @tparam <T> 表示接口提供访问的贡献类型的（通用）类型参数
 * \endchinese
 * \english
 * ContributionProvider
 * This interfaces provides access to a contribution.
 *
 * NOTE: This interface is not relevant for contributions with a HTML-based user
 * interface.
 *
 * @tparam <T> the (generic) type parameter for the interface representing the
 * type of contribution the interface provides access to
 * \endenglish
 */
template <class T>
class ContributionProvider
{
public:
    virtual ~ContributionProvider() = default;
 
    /**
     * \chinese
     * 获取一个贡献。在用户操作的结果中调用此方法以获取当前选中的节点。
     *
     * @return 相关的贡献
     * \endchinese
     * \english
     * Gets a contribution. Call this as the result of a user action to get the
     * currently selected node.
     *
     * @return the relevant contribution
     * \endenglish
     */
    virtual T *get() = 0;
};
 
template <class T>
using ContributionProviderPtr = std::shared_ptr<ContributionProvider<T>>;
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_CONTRIBUTION_PROVIDER_H