feature.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_FEATURE_H
#define AUBO_SCOPE_FEATURE_H
 
#include <vector>
#include <aubo_caps/class_forward.h>
 
namespace arcs {
namespace aubo_scope {
 
ARCS_CLASS_FORWARD(Feature);
 
/**
 * \chinese
 * 特征接口
 * 此基础接口表示 AuboScope 中所有可用的特征类型。
 * \endchinese
 * \english
 * Feature
 * This base interface represents all types of features available in AuboScope.
 * \endenglish
 */
class ARCS_ABI_EXPORT Feature
{
public:
    Feature(Feature &f);
    Feature(Feature &&f);
    virtual ~Feature();
 
    /**
     * \chinese
     * 获取特征的显示名称。注意：特征可随时被重命名。
     * @return 特征名称。
     * \endchinese
     * \english
     * Note: The feature can be renamed at any time.
     * @return The name of the feature.
     * \endenglish
     */
    std::string getDisplayName();
 
    /**
     * \chinese
     * 返回特征的位置是否已完全定义/指定。
     * @return 如果特征已定义返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * Returns whether the position of the feature has been fully
     * defined/specified.
     *
     * @return <code>true</code> if the feature is defined, <code>false</code>
     * otherwise.
     * \endenglish
     */
    bool isDefined();
 
    /**
     * \chinese
     * 返回特征是否可作为变量在程序中使用。
     * @return 如果特征可作为变量使用返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * Returns whether the feature can be used as a variable in the program.
     *
     * @return <code>true</code> if the feature is variable, <code>false</code>
     * otherwise.
     * \endenglish
     */
    bool isVariable();
    bool isJoggable();
 
    /**
     * \chinese
     * 特征无法保证始终存在于AuboScope中。终端用户可以加载不包含该特征的不同安装，
     * 或者终端用户或添加该特征的AuboCap可以将其移除。此方法用于判断特征是否存在。
     * @return 如果此特征存在于AuboScope中返回<code>true</code>，否则返回
     * <code>false</code>。
     * \endchinese
     * \english
     * A feature cannot be guaranteed to be present in AuboScope. The end user
     * can load a different installation (not containing the feature) or the
     * feature can be removed by the end user or the AuboCap that added the
     * feature. This method can be used to determine, if the feature is present.
     *
     * @return <code>true</code> if this feature is present in AuboScope,
     * otherwise <code>false</code>.
     * \endenglish
     */
    bool isResolvable();
 
    /**
     * \chinese
     * 返回特征的笛卡尔位置。
     * @return 表示特征笛卡尔位置的位姿。
     * \endchinese
     * \english
     * Returns the Cartesian location of the feature.
     * @return A pose representing the Cartesian location of the feature.
     * \endenglish
     */
    std::vector<double> getPose();
 
    size_t hashCode();
 
protected:
    Feature();
 
private:
    friend class DataSwitch;
    void *d_{ nullptr };
};
 
struct FeatureDefinedFilter
{
    bool operator()(FeaturePtr feature)
    {
        return feature && feature->isDefined();
    }
};
 
struct FeatureJoggableFilter
{
    bool operator()(FeaturePtr feature)
    {
        return feature && feature->isJoggable() && feature->isDefined();
    }
};
 
} // namespace aubo_scope
} // namespace arcs
#endif