AuboStudio SDK 0.6.3

installation_api.h
浏览该文件的文档.
1 #ifndef AUBO_SCOPE_INSTALLATION_API_H
2 #define AUBO_SCOPE_INSTALLATION_API_H
3
4 #include <aubo_caps/domain/application_api.h>
5 #include <aubo_caps/domain/function/function_model.h>
6 #include <aubo_caps/domain/tcp/tcp_contribution_model.h>
7 #include <aubo_caps/domain/feature/feature_contribution_model.h>
8 #include <aubo_caps/domain/payload/payload_contribution_model.h>
9
10 namespace arcs {
11 namespace aubo_scope {
12 ARCS_CLASS_FORWARD(InstallationApi);
13
14 /**
15 * @defgroup InstallationApi
16 * Provides access to functionality and services related to the installation.
17 * This includes what is available from within AuboScope, as well as creating
18 * additional model elements to be used within AuboScope.
19 */
20 class ARCS_ABI_EXPORT InstallationApi : public ApplicationApi
21 {
22 public:
23 InstallationApi(InstallationApi &f);
24 InstallationApi(InstallationApi &&f);
25 virtual ~InstallationApi();
26
27 /**
28 * @ingroup InstallationApi
29 * @return An interface for adding script functions to AuboScope
30 */
31 FunctionModelPtr getFunctionModel();
32
33 /**
34 * @ingroup InstallationApi
35 * @return An interface for contributing TCPs to AuboScope
36 */
37 TcpContributionModelPtr getTcpContributionModel();
38
39 /**
40 * @ingroup InstallationApi
41 * @return An interface for contributing features to AuboScope
42 */
43 FeatureContributionModelPtr getFeatureContributionModel();
44
45 /**
46 * @ingroup InstallationApi
47 * <p>
48 * Gets an interface which provides functionality for contributing payloads
49 * to the AuboScope installation.
50 * </p>
51 *
52 * @return An interface for contributing payloads to AuboScope
53 */
54 PayloadContributionModelPtr getPayloadContributionModel();
55
56 private:
57 friend class DataSwitch;
58 InstallationApi();
59 void *d_{ nullptr };
60 };
61
62 } // namespace aubo_scope
63 } // namespace arcs
64
65 #endif // AUBO_SCOPE_INSTALLATION_API_H
application_api.h
ARCS_ABI_EXPORT
#define ARCS_ABI_EXPORT
Definition: class_forward.h:16
arcs::aubo_scope::ApplicationApi
Definition: application_api.h:30
arcs::aubo_scope::InstallationApi
Definition: installation_api.h:21
arcs::aubo_scope::InstallationApi::~InstallationApi
virtual ~InstallationApi()
arcs::aubo_scope::InstallationApi::InstallationApi
InstallationApi()
arcs::aubo_scope::InstallationApi::InstallationApi
InstallationApi(InstallationApi &f)
arcs::aubo_scope::InstallationApi::InstallationApi
InstallationApi(InstallationApi &&f)
feature_contribution_model.h
function_model.h
arcs::aubo_scope::InstallationApi::getFunctionModel
FunctionModelPtr getFunctionModel()
arcs::aubo_scope::InstallationApi::getTcpContributionModel
TcpContributionModelPtr getTcpContributionModel()
arcs::aubo_scope::InstallationApi::getPayloadContributionModel
PayloadContributionModelPtr getPayloadContributionModel()
arcs::aubo_scope::InstallationApi::getFeatureContributionModel
FeatureContributionModelPtr getFeatureContributionModel()
arcs::aubo_scope::ARCS_CLASS_FORWARD
ARCS_CLASS_FORWARD(GripForceCapability)
arcs
Definition: contribution_provider.h:7
payload_contribution_model.h
tcp_contribution_model.h