tcp_contribution_model.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_TCP_CONTRIBUTION_MODEL_H
#define AUBO_SCOPE_TCP_CONTRIBUTION_MODEL_H
 
#include <aubo_caps/domain/tcp/tcp.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(TcpContributionModel);
 
/**
 * @ingroup InstallationApi
 * \chinese
 * TCP 贡献模型
 * 此接口提供在 AuboScope 中添加、更新和删除 TCP 的功能。
 *
 * <b>注意：</b>此接口只能在安装贡献中使用。
 * \endchinese
 * \english
 * TcpContributionModel
 * This interface provides functionality for adding, updating and removing TCPs
 * in AuboScope.
 *
 * <b>Note: </b> This interface must only be used in an installation
 * contribution.
 * \endenglish
 */
class ARCS_ABI_EXPORT TcpContributionModel
{
public:
    TcpContributionModel(TcpContributionModel &f);
    TcpContributionModel(TcpContributionModel &&f);
    virtual ~TcpContributionModel();
 
    /**
     * @ingroup TcpContributionModel
     * @ref TCP
     * \chinese
     * 向当前AuboScope安装中添加一个TCP。添加后终端用户可选择该TCP，但不可修改。
     *
     * @param idKey 用于标识此TCP的键。该键仅对此AuboCap有效。
     * @param suggested_name 建议的TCP名称。
     * @param offset TCP相对于工具输出法兰的偏移量。
     * @return 在AuboScope中创建并注册的TCP。
     * @throws TCPAlreadyAddedException 如果已使用相同idKey添加过TCP。
     * @throws IllegalTCPNameException 如果建议的名称不匹配所需正则表达式。
     * @throws IllegalArgumentException 如果偏移量超出有效范围。
     * \endchinese
     * \english
     * Add a TCP to the current AuboScope installation. This makes it selectable
     * by the end user. The TCP is not modifiable by the end user.
     *
     * @param idKey The key to identify this TCP by.
     * @param suggested_name Suggested name for the TCP.
     * @param offset The offset of the TCP with respect to the tool output flange.
     * @return The TCP created and registered in AuboScope.
     * @throws TCPAlreadyAddedException If called twice using the same idKey.
     * @throws IllegalTCPNameException If the suggested name does not match regex.
     * @throws IllegalArgumentException If the offset is invalid.
     * \endenglish
     */
    TCPPtr addTcp(const std::string &idKey, const std::string &suggested_name,
                  const std::vector<double> &offset);
 
    /**
     * @ingroup TcpContributionModel
     * @ref TCP
     * \chinese
     * 返回此前由此AuboCap使用相同idKey添加的TCP。
     * @param idKey TCP标识符键。
     * @return 此前添加的TCP，如果不存在则返回<code>null</code>。
     * \endchinese
     * \english
     * Returns the TCP previously added by this AuboCap using the same idKey.
     * @param idKey The key to identify this TCP by.
     * @return The TCP previously added by this AuboCap.
     * \endenglish
     */
    TCPPtr getTcp(const std::string &idKey);
 
    /**
     * @ingroup TcpContributionModel
     * \chinese
     * 更新此AuboCap已添加TCP的偏移量。
     * @param idKey TCP标识符键。
     * @param newOffset TCP的新偏移量。
     * @throws TCPNotFoundException 如果不存在对应idKey的TCP。
     * @throws IllegalArgumentException 如果偏移量超出有效范围。
     * \endchinese
     * \english
     * Update the offset of a TCP already added by this AuboCap.
     * @param idKey The key to identify the TCP.
     * @param newOffset The new offset to set for the TCP.
     * @throws TCPNotFoundException If no TCP exists with the provided idKey.
     * @throws IllegalArgumentException If the offset is invalid.
     * \endenglish
     */
    void updateTcp(const std::string &idKey,
                   const std::vector<double> &newOffset);
 
    /**
     * @ingroup TcpContributionModel
     * \chinese
     * 从此AuboCap中移除已添加的TCP。使用该TCP的程序节点将变为未定义。
     * @param idKey 添加TCP时使用的键。
     * @throws TCPNotFoundException 如果不存在对应idKey的TCP。
     * \endchinese
     * \english
     * Remove a TCP added by this AuboCap from AuboScope.
     * @param idKey The key used to add the TCP with.
     * @throws TCPNotFoundException If no TCP exists with the provided idKey.
     * \endenglish
     */
    void removeTcp(const std::string &idKey);
 
private:
    friend class DataSwitch;
    TcpContributionModel();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // TCPCONTRIBUTIONMODEL_H