program_api.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_PROGRAM_API_H
#define AUBO_SCOPE_PROGRAM_API_H
 
#include <aubo_caps/domain/application_api.h>
#include <aubo_caps/domain/program/program_model.h>
#include <aubo_caps/domain/undoredo/undo_redo_manager.h>
#include <aubo_caps/domain/waypoint/waypoint_model.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ProgramApi);
 
/**
 * \chinese
 * @defgroup ProgramApi ProgramApi(程序)
 * @ingroup ProgramApi
 * 程序接口
 * 提供与程序相关的功能和服务访问。这包括 AuboScope 内部已有的功能，以及在
 * AuboScope 中创建要使用的额外模型元素。
 * \endchinese
 * \english
 * @defgroup ProgramApi ProgramApi
 * @ingroup ProgramApi
 * ProgramApi
 * Provides access to functionality and services related to programs. This
 * includes what is available from within AuboScope, as well as creating
 * additional model elements to be used within AuboScope.
 * \endenglish
 */
class ARCS_ABI_EXPORT ProgramApi : public ApplicationApi
{
public:
    ProgramApi(ProgramApi &f);
    ProgramApi(ProgramApi &&f);
    virtual ~ProgramApi();
 
    /**
     * @ingroup ProgramApi
     * @ref ProgramModel
     * \chinese
     * @return 用于操作程序节点子树的接口
     * \endchinese
     * \english
     * @return An interface for working with the sub-trees of a program node
     * \endenglish
     */
    ProgramModelPtr getProgramModel();
 
    /**
     * @ingroup ProgramApi
     * @ref WaypointModel
     * \chinese
     * @return 用于操作路点的接口
     * \endchinese
     * \english
     * @return An interface for working with waypoints
     * \endenglish
     */
    WaypointModelPtr getWaypointModel();
 
    /**
     * @ingroup ProgramApi
     * @ref UndoRedoManager
     * \chinese
     * @return 用于记录程序节点贡献可撤销更改的接口
     * \endchinese
     * \english
     * @return An interface for recording undoable changes for program node
     * contributions
     * \endenglish
     */
    UndoRedoManagerPtr getUndoRedoManager();
 
private:
    friend class DataSwitch;
    ProgramApi();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
#endif // AUBO_SCOPE_PROGRAM_API_H