pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | Events | List of all members
X3g::Plugin::Tool::ToolBase Class Referenceabstract

Base class of internal tools. More...

Inheritance diagram for X3g::Plugin::Tool::ToolBase:
Inheritance graph
[legend]

Public Member Functions

bool Start ()
 Try to start the tool. More...
 

Properties

DbEntity^  CreatedEntity [get]
 Returns the created entity. More...
 
bool IsRunning [get]
 True if the tool is running. More...
 

Events

ToolCallbackEventHandler^  ToolUpdated
 Occurs when tool finished work. More...
 

Detailed Description

Base class of internal tools.

Member Function Documentation

bool X3g::Plugin::Tool::ToolBase::Start ( )

Try to start the tool.

On success true is returned.

Property Documentation

DbEntity^ X3g::Plugin::Tool::ToolBase::CreatedEntity
get

Returns the created entity.

bool X3g::Plugin::Tool::ToolBase::IsRunning
get

True if the tool is running.

Event Documentation

ToolCallbackEventHandler^ X3g::Plugin::Tool::ToolBase::ToolUpdated

Occurs when tool finished work.