This class is used to control winIDEA plugins.
Python example: test_plugin_control.py
#include <CPluginController.h>
|
| CPluginController (std::shared_ptr< ConnectionMgr > spConnectionMgr, const std::string &rstrPluginName) |
| This class provides winIDEA plugin control. More...
|
|
void | open (const std::string &rstrViewName) |
| Opens a view. More...
|
|
void | close (const std::string &rstrViewName) |
| Closes a view. More...
|
|
bool | is_open (const std::string &rstrViewName) |
| Returns true if view is open. More...
|
|
void | refresh (const std::string &rstrViewName) |
| Refreshes a view. More...
|
|
std::string | invoke (const std::string &rstrCommand, const std::string &rstrParameters) |
| This method invokes plugin specific commands (non generic). More...
|
|
std::string | invoke (const std::string &rstrViewName, const std::string &rstrCommand, const std::string &rstrParameters) |
| This method invokes plugin specific commands (non generic). More...
|
|
iconnect::StrStrVectorMap | get_content (const std::string &rstrViewName, const std::string &rstrItemPath, const iconnect::IntVector &rvnColumns, bool bIsRecursive=true, bool bExpandOnDemand=false) |
| Returns view content. More...
|
|
◆ CPluginController()
isys::CPluginController::CPluginController |
( |
std::shared_ptr< ConnectionMgr > |
spConnectionMgr, |
|
|
const std::string & |
rstrPluginName |
|
) |
| |
This class provides winIDEA plugin control.
- Parameters
-
spConnectionMgr | connection object |
rstrPluginName | as defined in winIDEA |
Python example: test_plugin_control.py
◆ close()
void isys::CPluginController::close |
( |
const std::string & |
rstrViewName | ) |
|
Closes a view.
- Exceptions
-
IOException | if operation fails. |
- Parameters
-
rstrViewName | specifies view name |
Python example: test_plugin_control.py
◆ get_content()
iconnect::StrStrVectorMap isys::CPluginController::get_content |
( |
const std::string & |
rstrViewName, |
|
|
const std::string & |
rstrItemPath, |
|
|
const iconnect::IntVector & |
rvnColumns, |
|
|
bool |
bIsRecursive = true , |
|
|
bool |
bExpandOnDemand = false |
|
) |
| |
Returns view content.
- Exceptions
-
IOException | if operation fails. |
- Parameters
-
rstrViewName | view name |
rstrItemPath | item path (starts with '/', components are delimited with '/'); if empty, all items will be returned |
rvnColumns | column indexes (0-based); if empty, all columns will be returned |
bIsRecursive | if true, all descendants of the specified item will be returned too |
bExpandOnDemand | if true, all items on the way to (and including) the specified item will be temporarily expanded to load their contents if necessary |
- Returns
- view content as map - keys are item paths, their values are vectors of column values; the "header" key contains column names
Python example: test_get_content.py
◆ invoke() [1/2]
std::string isys::CPluginController::invoke |
( |
const std::string & |
rstrCommand, |
|
|
const std::string & |
rstrParameters |
|
) |
| |
This method invokes plugin specific commands (non generic).
- Exceptions
-
IOException | if operation fails. |
- Parameters
-
rstrCommand | command name |
rstrParameters | command parameters separated by colon |
- Returns
- command operation results Python example: test_plugin_control.py
◆ invoke() [2/2]
std::string isys::CPluginController::invoke |
( |
const std::string & |
rstrViewName, |
|
|
const std::string & |
rstrCommand, |
|
|
const std::string & |
rstrParameters |
|
) |
| |
This method invokes plugin specific commands (non generic).
- Exceptions
-
IOException | if operation fails. |
- Parameters
-
rstrViewName | specifies view name |
rstrCommand | command |
rstrParameters | command parameters separated by colon |
- Returns
- command operation results Python example: test_plugin_control.py
◆ is_open()
bool isys::CPluginController::is_open |
( |
const std::string & |
rstrViewName | ) |
|
Returns true if view is open.
- Exceptions
-
IOException | if operation fails. |
- Parameters
-
rstrViewName | specifies view name |
- Returns
- true if view open, false otherwise
Python example: test_plugin_control.py
◆ open()
void isys::CPluginController::open |
( |
const std::string & |
rstrViewName | ) |
|
Opens a view.
- Exceptions
-
IOException | if operation fails. |
- Parameters
-
rstrViewName | specifies view name |
Python example: test_plugin_control.py
◆ refresh()
void isys::CPluginController::refresh |
( |
const std::string & |
rstrViewName | ) |
|
Refreshes a view.
- Exceptions
-
IOException | if operation fails. |
- Parameters
-
rstrViewName | specifies view name |
Python example: test_plugin_control.py