tcp.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_TCP_H
#define AUBO_SCOPE_TCP_H
 
#include <string>
#include <vector>
#include <aubo_caps/class_forward.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(TCP);
 
/**
 * @ingroup InstallationApi
 * \chinese
 * TCP 接口
 * 此接口表示 AuboScope 中的一个 TCP（工具中心点）。可以是用户定义的 TCP，也可以
 * 是由 AuboCap 添加的 TCP。
 * \endchinese
 * \english
 * TCP
 * This interface represents a TCP in AuboScope. This can either be a
 * user-defined TCP or a TCP added by a AuboCap.
 * \endenglish
 */
class ARCS_ABI_EXPORT TCP
{
public:
    TCP(TCP &f);
    TCP(TCP &&f);
    ~TCP();
 
    /**
     * @ingroup TCP
     * \chinese
     * 获取TCP相对于工具输出法兰的偏移量
     * @return TCP偏移量。
     * \endchinese
     * \english
     * Returns the offset of the TCP with respect to the tool output flange.
     * @return The offset of the TCP.
     * \endenglish
     */
    std::vector<double> getOffset();
 
    /**
     * @ingroup TCP
     * \chinese
     * 获取TCP显示名称。注意：TCP可随时被重命名。
     * @return TCP名称。
     * \endchinese
     * \english
     * Note: The TCP can be renamed at any time.
     * @return The name of the TCP.
     * \endenglish
     */
    std::string getDisplayName();
 
    /**
     * @ingroup TCP
     * \chinese
     * TCP无法保证始终存在。终端用户可加载不包含该TCP的其他安装，或该TCP可被终端用户
     * 或添加该TCP的AuboCap删除。此方法用于判断TCP是否存在。
     * @return 如果TCP存在返回<code>true</code>，否则返回<code>false</code>。
     * \endchinese
     * \english
     * A TCP cannot be guaranteed to be present in AuboScope. The end user can
     * load a different installation (not containing the TCP) or the TCP was
     * removed by the end user or the AuboCap that added the tcp. This method
     * can be used to determine, if the TCP is present.
     *
     * @return <code>true</code> if this TCP is present in AuboScope, otherwise
     * <code>false</code>.
     * \endenglish
     */
    bool isResolvable();
 
    /**
     * @ingroup TCP
     * \chinese
     * 获取哈希码
     * @return 哈希码。
     * \endchinese
     * \english
     * Returns the hash code.
     * @return the hash code.
     * \endenglish
     */
    size_t hashCode();
 
private:
    friend class DataSwitch;
    TCP();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_TCP_H