arcs::aubo_scope::ProgramNodeContribution Class Reference

Defines an API required for specifying a AuboCap Program Node within AuboScope. More...

#include <program_node_contribution.h>

Public Member Functions
virtual	~ProgramNodeContribution ()=default
virtual void	openView ()=0
	Called when this node is selected in the program tree. More...
virtual void	closeView ()=0
	Called when this node is unselected in the program tree or when navigating to another view. More...
virtual std::string	getTitle ()=0
virtual bool	isDefined ()=0
virtual void	generateScript (ScriptWriterPtr script_writer)=0
	Defines the script code to be generated by this program node within the program. More...
virtual std::string	postAction (const char *pattern, const std::string &body)
	post More...
virtual std::string	getAction (const char *pattern, const std::string &body)
	GET. More...

Detailed Description

Defines an API required for specifying a AuboCap Program Node within AuboScope.

Definition at line 16 of file program_node_contribution.h.

Constructor & Destructor Documentation

virtual arcs::aubo_scope::ProgramNodeContribution::~ProgramNodeContribution ( )

virtualdefault

Member Function Documentation

virtual void arcs::aubo_scope::ProgramNodeContribution::closeView ( )

pure virtual

Called when this node is unselected in the program tree or when navigating to another view.

virtual void arcs::aubo_scope::ProgramNodeContribution::generateScript ( ScriptWriterPtr  script_writer )

pure virtual

Defines the script code to be generated by this program node within the program.

Parameters

writer

serves to add script commands that define the behaviour of this program node.

virtual std::string arcs::aubo_scope::ProgramNodeContribution::getAction ( const char *  pattern, const std::string &  body  )

inlinevirtual

GET.

Parameters

pattern
body

Returns

Definition at line 88 of file program_node_contribution.h.

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

pure virtual

Returns

The text displayed in the Program Tree for the program node.

Exceptions

IllegalStateException

if the data model or child program sub-tree is modified

virtual bool arcs::aubo_scope::ProgramNodeContribution::isDefined ( )

pure virtual

Should return true if this program node is complete, and false otherwise.

Undefined program nodes will be marked with yellow in the program tree. The user cannot start the program as long as it contains one or more undefined program nodes.

If this program node stores an unresolvable entity (e.g. variable/PersistedVariable or tcp/TCP) in its DataModel, the program node will be treated as undefined.

Returns

true if this program node is complete and otherwise false.

Exceptions

IllegalStateException

if the data model or child program sub-tree is modified.

virtual void arcs::aubo_scope::ProgramNodeContribution::openView ( )

pure virtual

Called when this node is selected in the program tree.

virtual std::string arcs::aubo_scope::ProgramNodeContribution::postAction ( const char *  pattern, const std::string &  body  )

inlinevirtual

post

Parameters

pattern
body

Returns

Definition at line 78 of file program_node_contribution.h.

---

The documentation for this class was generated from the following file:

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