AuboStudio SDK 0.6.3

payload_model.h
浏览该文件的文档.
1 #ifndef AUBO_SCOPE_PAYLOAD_MODEL_H
2 #define AUBO_SCOPE_PAYLOAD_MODEL_H
3
4 #include <vector>
5 #include <aubo_caps/class_forward.h>
6
7 namespace arcs {
8 namespace aubo_scope {
9 ARCS_CLASS_FORWARD(PayloadModel);
10 ARCS_CLASS_FORWARD(Payload);
11
12 /**
13 * @defgroup PayloadModel PayloadModel (负载参数)
14 * \~chinese 获取负载参数API接口
15 * \~english API interface for payload parameters
16 */
17
18 class ARCS_ABI_EXPORT PayloadModel
19 {
20 public:
21 PayloadModel(PayloadModel &f);
22 PayloadModel(PayloadModel &&f);
23 virtual ~PayloadModel();
24
25 /**
26 * @ingroup PayloadModel
27 * @brief getPayloads
28 * @return A collection of all the payloads from the current
29 * installation in AuboScope, including user-defined payloads and
30 * payloads added by aubo_studio plugins.
31 */
32 std::vector<PayloadPtr> getPayloads() const;
33 /**
34 * @ingroup PayloadModel
35 * @brief getPayload
36 * @param name
37 * @return
38 */
39 PayloadPtr getPayload(const std::string &name) const;
40 /**
41 * @ingroup PayloadModel
42 * @brief getDefaultPayload
43 * @return
44 */
45 PayloadPtr getDefaultPayload() const;
46 /**
47 * @ingroup PayloadModel
48 * @brief getCurrentPayload
49 * @return
50 */
51 PayloadPtr getCurrentPayload() const;
52
53 private:
54 friend class DataSwitch;
55 PayloadModel();
56 void *d_{ nullptr };
57 };
58 } // namespace aubo_scope
59 } // namespace arcs
60
61 #endif // PAYLOADMODEL_H
class_forward.h
ARCS_ABI_EXPORT
#define ARCS_ABI_EXPORT
Definition: class_forward.h:16
arcs::aubo_scope::PayloadModel
Definition: payload_model.h:19
arcs::aubo_scope::PayloadModel::PayloadModel
PayloadModel(PayloadModel &&f)
arcs::aubo_scope::PayloadModel::~PayloadModel
virtual ~PayloadModel()
arcs::aubo_scope::PayloadModel::PayloadModel
PayloadModel()
arcs::aubo_scope::PayloadModel::PayloadModel
PayloadModel(PayloadModel &f)
arcs::aubo_scope::Payload
Definition: payload.h:17
arcs::aubo_scope::PayloadModel::getCurrentPayload
PayloadPtr getCurrentPayload() const
getCurrentPayload
arcs::aubo_scope::PayloadModel::getDefaultPayload
PayloadPtr getDefaultPayload() const
getDefaultPayload
arcs::aubo_scope::PayloadModel::getPayload
PayloadPtr getPayload(const std::string &name) const
getPayload
arcs::aubo_scope::PayloadModel::getPayloads
std::vector< PayloadPtr > getPayloads() const
getPayloads
arcs::aubo_scope::ARCS_CLASS_FORWARD
ARCS_CLASS_FORWARD(GripForceCapability)
arcs
Definition: contribution_provider.h:7