AuboStudio SDK 0.6.3

program_api.h
浏览该文件的文档.
1 #ifndef AUBO_SCOPE_PROGRAM_API_H
2 #define AUBO_SCOPE_PROGRAM_API_H
3
4 #include <aubo_caps/domain/application_api.h>
5 #include <aubo_caps/domain/program/program_model.h>
6 #include <aubo_caps/domain/undoredo/undo_redo_manager.h>
7 #include <aubo_caps/domain/waypoint/waypoint_model.h>
8
9 namespace arcs {
10 namespace aubo_scope {
11 ARCS_CLASS_FORWARD(ProgramApi);
12
13 /**
14 * Provides access to functionality and services related to programs. This
15 * includes what is available from within AuboScope, as well as creating
16 * additional model elements to be used within AuboScope.
17 */
18 class ARCS_ABI_EXPORT ProgramApi : public ApplicationApi
19 {
20 public:
21 ProgramApi(ProgramApi &f);
22 ProgramApi(ProgramApi &&f);
23 virtual ~ProgramApi();
24
25 /**
26 * @return An interface for working with the sub-trees of a program node
27 */
28 ProgramModelPtr getProgramModel();
29
30 /**
31 * @return An interface for working with waypoints
32 */
33 WaypointModelPtr getWaypointModel();
34
35 /**
36 * @return An interface for recording undoable changes for program node
37 * contributions
38 */
39 UndoRedoManagerPtr getUndoRedoManager();
40
41 private:
42 friend class DataSwitch;
43 ProgramApi();
44 void *d_{ nullptr };
45 };
46
47 } // namespace aubo_scope
48 } // namespace arcs
49 #endif // AUBO_SCOPE_PROGRAM_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::ProgramApi
Provides access to functionality and services related to programs.
Definition: program_api.h:19
arcs::aubo_scope::ProgramApi::ProgramApi
ProgramApi(ProgramApi &&f)
arcs::aubo_scope::ProgramApi::ProgramApi
ProgramApi(ProgramApi &f)
arcs::aubo_scope::ProgramApi::getUndoRedoManager
UndoRedoManagerPtr getUndoRedoManager()
arcs::aubo_scope::ProgramApi::~ProgramApi
virtual ~ProgramApi()
arcs::aubo_scope::ProgramApi::getProgramModel
ProgramModelPtr getProgramModel()
arcs::aubo_scope::ProgramApi::getWaypointModel
WaypointModelPtr getWaypointModel()
arcs::aubo_scope::ProgramApi::ProgramApi
ProgramApi()
arcs::aubo_scope::ARCS_CLASS_FORWARD
ARCS_CLASS_FORWARD(GripForceCapability)
arcs
Definition: contribution_provider.h:7
program_model.h
undo_redo_manager.h
waypoint_model.h