arcs::aubo_scope::ProgramNodeService类 参考

Defines an API required for adding a new type of program node to AuboScope. 更多...

#include <program_node_service.h>

Public 成员函数
virtual	~ProgramNodeService ()=default
virtual std::string	getId ()=0
	Get the unique identifier for this kind of program node.
virtual std::string	getTitle ()=0
virtual std::string	getIcon ()=0
virtual void	configureContribution (ProgramContributionConfigurationPtr configuration)=0
	configureContribution
virtual ProgramNodeViewPtr	createView (ViewApiProviderPtr api_provider)=0
	Creates a new View instance which implements the UI for your program node screen.
virtual ProgramNodeContributionPtr	createNode (ProgramApiProviderPtr api_provider, ProgramNodeViewPtr view, DataModelPtr model, ProgramCreationContextPtr context)=0

详细描述

Defines an API required for adding a new type of program node to AuboScope.

在文件 program_node_service.h 第 18 行定义.

构造及析构函数说明

~ProgramNodeService()

virtual arcs::aubo_scope::ProgramNodeService::~ProgramNodeService ( )

virtualdefault

成员函数说明

configureContribution()

virtual void arcs::aubo_scope::ProgramNodeService::configureContribution ( ProgramContributionConfigurationPtr configuration )

pure virtual

configureContribution

参数

configuration

createNode()

virtual ProgramNodeContributionPtr arcs::aubo_scope::ProgramNodeService::createNode ( ProgramApiProviderPtr api_provider, ProgramNodeViewPtr view, DataModelPtr model, ProgramCreationContextPtr context )

pure virtual

Creates a new program node contribution instance.

The returned node must use the supplied data model object to retrieve and store the data contained in it. All modifications to the supplied data model from the program node constructor are ignored when an existing program node is loaded or copy/pasted. Every change to the model object is registered as a separate undo/redo event in the program tree.

参数

api	the AuboCap API object with access to domain data
model	object where all configuration data of the new program node instance is to be stored in and retrieved from

返回

the newly constructed program node contribution instance

createView()

virtual ProgramNodeViewPtr arcs::aubo_scope::ProgramNodeService::createView ( ViewApiProviderPtr api_provider )

pure virtual

Creates a new View instance which implements the UI for your program node screen.

Called once when a new program is loaded or created.

参数

apiProvider

Provides access to functionality and services available from within AuboScope related to user interface and end user interaction

返回

the view

getIcon()

virtual std::string arcs::aubo_scope::ProgramNodeService::getIcon ( )

pure virtual

返回

The text displayed in the Structure Tab for program nodes created by this factory.

getId()

virtual std::string arcs::aubo_scope::ProgramNodeService::getId ( )

pure virtual

Get the unique identifier for this kind of program node.

The identifier will be used when storing programs that use the program node.

返回

the unique identifier.

getTitle()

virtual std::string arcs::aubo_scope::ProgramNodeService::getTitle ( )

pure virtual

返回

The text displayed in the Structure Tab for program nodes created by this factory.

---

该类的文档由以下文件生成:

• include/aubo_caps/contribution/program/program_node_service.h