AuboStudio SDK 0.6.3

tcp.h
浏览该文件的文档.
1 #ifndef AUBO_SCOPE_TCP_H
2 #define AUBO_SCOPE_TCP_H
3
4 #include <string>
5 #include <vector>
6 #include <aubo_caps/class_forward.h>
7
8 namespace arcs {
9 namespace aubo_scope {
10 ARCS_CLASS_FORWARD(TCP);
11
12 /**
13 * This interface represents a TCP in AuboScope. This can either be a
14 * user-defined TCP or a TCP added by a AuboCap.
15 */
16 class ARCS_ABI_EXPORT TCP
17 {
18 public:
19 TCP(TCP &f);
20 TCP(TCP &&f);
21 ~TCP();
22
23 /**
24 * @return The offset of the TCP with respect to the tool output flange, if
25 * the TCP is resolvable, otherwise null.
26 */
27 std::vector<double> getOffset();
28
29 /**
30 * Note: The TCP can be renamed at any time
31 *
32 * @return The name of the TCP
33 */
34 std::string getDisplayName();
35
36 /**
37 * A TCP cannot be guaranteed to be present in AuboScope. The end user can
38 * load a different installation (not containing the TCP) or the TCP was
39 * removed by the end user or the AuboCap that added the tcp/ This method
40 * can be used to determine, if the TCP is present.
41 *
42 * @return <code>true</code> if this TCP is present in AuboScope, otherwise
43 * <code>false</code>.
44 */
45 bool isResolvable();
46
47 size_t hashCode();
48
49 private:
50 friend class DataSwitch;
51 TCP();
52 void *d_{ nullptr };
53 };
54
55 } // namespace aubo_scope
56 } // namespace arcs
57
58 #endif // AUBO_SCOPE_TCP_H
class_forward.h
ARCS_ABI_EXPORT
#define ARCS_ABI_EXPORT
Definition: class_forward.h:16
arcs::aubo_scope::TCP
This interface represents a TCP in AuboScope.
Definition: tcp.h:17
arcs::aubo_scope::TCP::isResolvable
bool isResolvable()
A TCP cannot be guaranteed to be present in AuboScope.
arcs::aubo_scope::TCP::getDisplayName
std::string getDisplayName()
Note: The TCP can be renamed at any time
arcs::aubo_scope::TCP::hashCode
size_t hashCode()
arcs::aubo_scope::TCP::TCP
TCP()
arcs::aubo_scope::TCP::TCP
TCP(TCP &&f)
arcs::aubo_scope::TCP::getOffset
std::vector< double > getOffset()
arcs::aubo_scope::TCP::~TCP
~TCP()
arcs::aubo_scope::TCP::TCP
TCP(TCP &f)
arcs::aubo_scope::ARCS_CLASS_FORWARD
ARCS_CLASS_FORWARD(GripForceCapability)
arcs
Definition: contribution_provider.h:7