waypoint.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_WAYPOINT_H
#define AUBO_SCOPE_WAYPOINT_H
 
#include <vector>
#include <string>
#include <aubo_caps/class_forward.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(Waypoint);
 
/**
 * @ingroup ProgramApi
 * This interface composes parameters that define a position of the robot.
 */
class ARCS_ABI_EXPORT Waypoint
{
public:
    Waypoint(Waypoint &f);
    Waypoint(Waypoint &&f);
    ~Waypoint();
 
    /**
     * @ingroup Waypoint
     * @brief getDisplayName
     * @return Display name
     */
    std::string getDisplayName();
 
    /**
     * @ingroup Waypoint
     * @return the pose for the position of the robot (including the TCP offset)
     */
    std::vector<double> getPose();
 
    /**
     * @ingroup Waypoint
     * @return the joint positions corresponding to the pose of the robot (when
     * taking the TCP offset into account)
     */
    std::vector<double> getJointPositions();
 
    /**
     * @ingroup Waypoint
     * @return the pose for the TCP offset (used when defining the robot
     * position)
     */
    std::vector<double> getTcpOffset();
 
    /**
     * @ingroup Waypoint
     * @brief isDefined
     * @return
     */
    bool isDefined();
 
    /**
     * @ingroup Waypoint
     * @brief hashCode
     * @return
     */
    size_t hashCode();
 
private:
    friend class DataSwitch;
    Waypoint();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_WAYPOINT_H