#include <WSMap.h>
|
WSLink * | link (const QString &fromModule, const QString &fromPort, const QString &toModule, const QString &toPort) |
|
bool | unlink (const QString &fromModule, const QString &fromPort, const QString &toModule, const QString &toPort) |
|
bool | unlink (WSLink *link) |
|
bool | unlink (const QString &linkID) |
|
WSLink * | getLink (const QString &linkID) const |
|
QList< WSLink * > | getLinks () const |
|
WSModule * | getModule (const QString &name, const QString &instance, const QString &host) const |
|
WSModule * | getModule (const QString &moduleID) const |
|
WSModule * | getModuleByTitle (const QString &title) const |
|
QList< WSModule * > | getModules () const |
|
void | setMapName (const QString &name) |
|
const QString & | getMapName () const |
|
static QString | makeKeyName (const QString &name, const QString &instance, const QString &host) |
|
covise::WSMap::~WSMap |
( |
| ) |
|
|
virtual |
Adds a module to the map of running modules. Takes its parameter as template and clones it. This method is intended to be used when instantiating non-instantiated modules
- Parameters
-
module | the module to be added |
instance | the module instance id |
host | the host the module is running on |
- Returns
- the module created
Adds a module to the map of running modules. Takes its parameter as template and clones it. This method is intended to be used when adding already instantiated modules
- Parameters
-
module | the module to be added |
- Returns
- the module created
covise::WSModule * covise::WSMap::addModule |
( |
const covise::covise__Module & |
module | ) |
|
Adds a module to the map of running modules. Takes its parameter as template and clones it. This method is intended to be used when adding already instantiated modules
- Parameters
-
module | the module to be added |
- Returns
- the module created
covise::WSLink * covise::WSMap::getLink |
( |
const QString & |
linkID | ) |
const |
|
slot |
const QString& covise::WSMap::getMapName |
( |
| ) |
const |
|
inlineslot |
Get the name of the currently loaded map
- Returns
- the name of the currently loaded map
covise::WSModule * covise::WSMap::getModule |
( |
const QString & |
name, |
|
|
const QString & |
instance, |
|
|
const QString & |
host |
|
) |
| const |
|
slot |
- Returns
- the module or 0 if no module with that name/instance/host combination exists
- Parameters
-
name | The name of the module |
instance | The number of the module |
host | The IP of the host the module is running on |
- Parameters
-
moduleID | The id of the module |
- Returns
- the module or 0 if no module with that moduleID exists
covise::WSModule * covise::WSMap::getModuleByTitle |
( |
const QString & |
title | ) |
const |
|
slot |
Gets a module by title. If no module has the given title, 0 is returned. If more than one module has that title, the result is undefined.
- Parameters
-
title | The title of the module |
- Returns
- The module with the given title, 0 if no module has that title.
Get a list of all running modules
covise::WSLink * covise::WSMap::link |
( |
const QString & |
fromModule, |
|
|
const QString & |
fromPort, |
|
|
const QString & |
toModule, |
|
|
const QString & |
toPort |
|
) |
| |
|
slot |
Add a link between an output port and an input port of a module
- Parameters
-
fromModule | Module ID of the output port |
fromPort | Port name of the output port |
toModule | Module ID of the input port |
toPort | Port name of the input port |
- Returns
- the new link created or 0 on error
void covise::WSMap::linkDestroyed |
( |
const QString & |
linkID | ) |
|
|
privateslot |
QString covise::WSMap::makeKeyName |
( |
const QString & |
name, |
|
|
const QString & |
instance, |
|
|
const QString & |
host |
|
) |
| |
|
staticslot |
Make unique name for module
- Parameters
-
name | The name of the running module |
instance | The instance of the running module |
host | The host the module is running on |
void covise::WSMap::moduleRemoved |
( |
const QString & |
moduleID | ) |
|
|
signal |
void covise::WSMap::printList |
( |
const QMap< QString, WSModule * > & |
map | ) |
|
|
private |
Print content of a map
- Parameters
-
map | The name of the QMap to be printed |
const QString & covise::WSMap::removeModule |
( |
const QString & |
moduleID | ) |
|
Remove a module from the map
- Returns
- the name of the the removed module
- Parameters
-
moduleID | the moduleID of the module to be removed |
void covise::WSMap::setMapName |
( |
const QString & |
name | ) |
|
|
slot |
Set the name of the map
- Parameters
-
void covise::WSMap::setRunningModules |
( |
const QMap< QString, WSModule * > & |
modules | ) |
|
|
inlineprivate |
Set the running Modules
- Parameters
-
inModules | The new value of runningModules |
Removes a module from the map without deleting it
- Returns
- the removed module or 0 if no module with moduleID found
- Parameters
-
moduleID | the moduleID of the module to be removed |
bool covise::WSMap::unlink |
( |
const QString & |
fromModule, |
|
|
const QString & |
fromPort, |
|
|
const QString & |
toModule, |
|
|
const QString & |
toPort |
|
) |
| |
|
slot |
bool covise::WSMap::unlink |
( |
const QString & |
linkID | ) |
|
|
slot |
QString covise::WSMap::mapName |
|
private |
QMap<QString, WSModule *> covise::WSMap::runningModules |
|
private |
QString covise::WSMap::mapname |
|
readwrite |
The documentation for this class was generated from the following files: