feature_model.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_FEATURE_MODEL_H
#define AUBO_SCOPE_FEATURE_MODEL_H
 
#include <vector>
#include <functional>
#include <aubo_caps/domain/feature/feature.h>
 
namespace arcs {
namespace aubo_scope {
 
ARCS_CLASS_FORWARD(FeatureModel);
 
/**
 * @ingroup ApplicationApi
 * \chinese
 * 特征模型
 * 提供从当前机器人安装中获取特征的方法。
 * \endchinese
 * \english
 * FeatureModel
 * Provides methods that returns features from the current robot installation.
 * \endenglish
 */
class ARCS_ABI_EXPORT FeatureModel
{
public:
    FeatureModel(FeatureModel &f);
    FeatureModel(FeatureModel &&f);
    ~FeatureModel();
 
    std::vector<FeaturePtr> getAll();
 
    /**
     * @ingroup FeatureModel
     * \chinese
     * 获取当前安装中的几何特征
     * @return 几何特征集合。
     * \endchinese
     * \english
     * Returns the geometric features of the current installation.
     * @return the geometric features of the current installation.
     * \endenglish
     */
    template <typename T>
    std::vector<FeaturePtr> getGeomFeture();
 
    /**
     * @ingroup FeatureModel
     * \chinese
     * 根据名称获取特征
     * @param name 特征名称。
     * @return 对应名称的特征。
     * \endchinese
     * \english
     * Returns a feature by name.
     * @param name the name of the feature.
     * @return the feature with the given name.
     * \endenglish
     */
    FeaturePtr getByName(const std::string &name);
 
    /**
     * @ingroup FeatureModel
     * \chinese
     * 获取当前安装的基础特征
     * @return 基础特征。
     * \endchinese
     * \english
     * Returns the base feature of the current installation.
     * @return the base feature of the current installation.
     * \endenglish
     */
    FeaturePtr getBaseFeature();
 
    /**
     * @ingroup FeatureModel
     * \chinese
     * 获取当前安装的工具特征
     * @return 工具特征。
     * \endchinese
     * \english
     * Returns the tool feature of the current installation.
     * @return the tool feature of the current installation.
     * \endenglish
     */
    FeaturePtr getToolFeature();
 
    /**
     * @ingroup FeatureModel
     * \chinese
     * 根据过滤器获取特征列表
     * @param filter 过滤条件。
     * @return 满足过滤条件的特征集合。
     * \endchinese
     * \english
     * Returns features matching the given filter.
     * @param filter the filter to apply.
     * @return a collection of features that match the filter.
     * \endenglish
     */
    std::vector<FeaturePtr> getFeatures(std::function<bool(FeaturePtr)> filter);
 
private:
    friend class DataSwitch;
    FeatureModel();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_FEATURE_MODEL_H