MeVisLab Scripting Reference
Public Member Functions | List of all members
MLABRemoteModule Class Reference
Modules and Networks | Scripting
Inheritance diagram for MLABRemoteModule:
MLABMLModule MLABModule MLABFieldOwner

Public Slots

Scripting access.


bool isConnected () const
 
bool isConnectedToSameHost () const
 
void showWorker ()
 
qint64 workerPid () const
 
void killWorker ()
 
void requestStopProcessing ()
 
- Public Slots inherited from MLABMLModule
virtual QObject * object ()
 
- Public Slots inherited from MLABModule
void copyInstanceName ()
 
void editInstanceNameWithRequester ()
 
void editModuleHelp ()
 
QString exampleNetworkFile ()
 
QStringList exampleNetworkFiles ()
 
virtual void forceReload ()
 
QString getMLABFile ()
 
QString getModuleDefinitionFolder ()
 
QString getModuleHelpFile ()
 
QString getModuleSourcesFolder ()
 
QStringList getScriptSourceFiles ()
 
bool hasModuleHelp ()
 
bool isDefinedInsideProject () const
 
bool isLazyLoading () const
 
MLABTree * mdlTree ()
 
void openMLABFile ()
 
void openModuleDefinition ()
 
void openScriptSourceFiles ()
 
void restoreDefaultValues ()
 
void showContextMenu ()
 
void showDLLDependency ()
 
void showExampleNetwork ()
 
void showHtmlHelp ()
 
void showModuleInNetwork (bool openNetworkTabAfterCurrentNetworkTab=false)
 
void showScriptConsole ()
 
void updateModuleHelp ()
 
MLABMacroModule * parentMacro () const
 
MLABMacroModule * parent ()
 
MLABMacroModule * applicationMacro (bool shouldWarnIfNotMacro=true)
 
bool isDescendentOf (MLABModule *module)
 
bool isDescendentOfNetwork (MLABNetwork *network)
 
MLABNetwork * parentNetwork () const override
 
MLABNetwork * owner ()
 
virtual MLABNetwork * network ()
 
virtual bool isMacroModule ()
 
void createScriptingContext (const QString &language)
 
bool hasFunction (const QString &functionName)
 
QVariant scriptVariable (const QString &name)
 
void setScriptVariable (const QString &name, const QVariant &value)
 
void deleteScriptVariable (const QString &name)
 
QVariant call (const QString &function, const QVariantList &args)
 
QVariant call (const QString &function)
 
QVariant call (const QString &function, QObject *obj)
 
QObject * callWithObjectReturn (const QString &function, const QVariantList &args)
 
QObject * callWithObjectReturn (const QString &function)
 
QObject * callWithObjectReturn (const QString &function, QObject *obj)
 
int callLater (double seconds, const QVariant &function, const QVariantList &args=QVariantList())
 
int callWithInterval (double seconds, const QVariant &function, const QVariantList &args=QVariantList())
 
void callOnGUIThread (const QVariant &function, const QVariantList &args=QVariantList())
 
QStringList callableFunctions ()
 
QStringList deprecatedFieldNames (const QString &fieldName)
 
QStringList deprecatedFieldNames (MLABField *field)
 
QVariantMap deprecatedFieldNames ()
 
void removeTimer (int id)
 
void removeTimers ()
 
QObject * commandHandler (const QString &name)
 
bool connectField (const QString &dst, const QString &src)
 
bool disconnectField (const QString &input)
 
virtual void clearCache ()
 
virtual MLABField * field (const QString &name)
 
bool hasField (const QString &name)
 
virtual MLABModule * module (const QString &name)
 
bool hasModule (const QString &name)
 
QStringList modules ()
 
QList< MLABModule * > modulesAsObjects ()
 
virtual MLABModule * addModule (const QString &name)
 
virtual MLABModule * addLocalModule (const QString &name)
 
virtual MLABModule * addMacroModuleFromString (const QString &string)
 
virtual MLABModule * addMacroModuleFromFile (const QString &file)
 
virtual MLABModule * addRemoteModule (const QString &name)
 
virtual MLABWidgetControl * control (const QString &name)
 
bool hasControl (const QString &name)
 
MLABWidgetControl * controlDebug (const QString &name)
 
virtual void closeWindow ()
 
MLABWindowControl * window ()
 
QString unexpandFilename (const QString &file)
 
QString expandFilename (const QString &file, bool doCleanPath=true)
 
QString localPath ()
 
QString networkPath ()
 
void log (const QString &msg)
 
void logFixed (const QString &text)
 
void logHTML (const QString &msg)
 
void logWarning (const QString &msg)
 
void logError (const QString &msg)
 
int currentWindowID ()
 
int setCurrentWindowID (int windowID)
 
void remove ()
 
void py_delete ()
 
void removeUndoable ()
 
QMap< QString, QVariant > getDependency ()
 
bool exportWindows (const QStringList &windowNames=QStringList()<< "_default")
 
bool callRemoteFunction (const QString &functionName, const QVariantList &arguments=QVariantList(), const QVariant &replyHandler=QVariant())
 
QString translate (const QString &text, const QString &disambiguation=QString())
 
QStringList inputs ()
 
QStringList outputs ()
 
QStringList parameters ()
 
QList< MLABField * > inputFields ()
 
QList< MLABField * > outputFields ()
 
QList< MLABField * > parameterFields ()
 
bool isValid ()
 
void setNonPersistent ()
 
bool isPersistent () override
 
QString type () const
 
virtual bool isLocalMacro ()
 
bool shouldAvoidSideEffects () const
 
QString fullName () override
 
QRect frame () const
 
void setFrame (const QRect &frame)
 
void setFrameTopLeft (int x, int y)
 
void setFrameCenter (int x, int y)
 
bool isSelected () const override
 
void setSelected (bool flag, bool notifyModuleListener=true)
 
void setSingleSelected ()
 
MLABPackage * package ()
 
MLABPackage * getPackage ()
 
MLABWindowControl * showWindow (MLABWindowControl *parent=nullptr)
 
MLABWindowControl * showWindow (const QString &name, MLABWindowControl *parent=nullptr)
 
MLABWindowControl * showWindowFromString (const QString &string, MLABWindowControl *parent=nullptr)
 
MLABWindowControl * showWindowFromFile (const QString &file, MLABWindowControl *parent=nullptr)
 
MLABWindowControl * showAutomaticWindow ()
 
int showModalDialog (const QString &name, const QString &title)
 
int showModalDialog (const QString &name)
 
int showModalDialog ()
 
int showModalDialog (const QString &name, MLABWindowControl *parent)
 
int showModalDialogFromString (const QString &mdlString, const QString &title)
 
int showModalDialogFromString (const QString &mdlString)
 
int showModalDialogFromString (const QString &mdlString, MLABWindowControl *parent)
 
int showModalDialogFromFile (const QString &file, const QString &title)
 
int showModalDialogFromFile (const QString &file)
 
int showModalDialogFromFile (const QString &file, MLABWindowControl *parent)
 
MLABWindowControl * createWindow ()
 
MLABWindowControl * createWindow (MLABWindowControl *parent)
 
MLABWindowControl * createWindow (const QString &name)
 
MLABWindowControl * createWindow (const QString &name, MLABWindowControl *parent)
 
MLABWindowControl * createWindowFromFile (const QString &file)
 
MLABWindowControl * createWindowFromFile (const QString &file, MLABWindowControl *parent)
 
MLABWindowControl * createWindowFromString (const QString &string)
 
MLABWindowControl * createWindowFromString (const QString &string, MLABWindowControl *parent)
 
MLABWindowControl * createBorderlessWindow (const QString &name, MLABWindowControl *parent)
 
MLABWindowControl * createPopupWindow (const QString &name, MLABWindowControl *parent)
 
MLABWindowControl * createModalDialog (const QString &name, MLABWindowControl *parent)
 
bool hasWindow (const QString &name)
 
void closeAllWindows (bool emitDestroyedCommandImmediately=false)
 
void reshowClosedWindows ()
 
virtual MLABWindowControl * showParameterWindow ()
 
void updateLayout ()
 
void createConnectors ()
 
MLABFieldListener * addFieldListener (MLABField *field, const QVariant &script, bool init)
 
void removeFieldListener (MLABFieldListener *listener)
 
QString groupName () const
 
void addToGroup (const QString &name)
 
- Public Slots inherited from MLABFieldOwner
virtual bool isSelected () const =0
 
virtual bool isPersistent ()=0
 
virtual MLABNetwork * parentNetwork () const =0
 
virtual QString fullName ()=0
 

Public Member Functions

bool isRemote () override
 
void reload () override
 
bool shouldReload () override
 

Detailed Description

Defines a (proxy) module that is executed in a remote worker instance (really a ML module with some special handling).


See MLABModule, MLABRemoteModule currently does not provide additional methods.

Member Function Documentation

◆ isConnected

bool MLABRemoteModule::isConnected ( ) const
slot

Returns whether the proxy module is still connected with its remote counter-part.

◆ isConnectedToSameHost

bool MLABRemoteModule::isConnectedToSameHost ( ) const
slot

Returns whether the worker process lives on the same host computer.

◆ isRemote()

bool MLABRemoteModule::isRemote ( )
inlineoverridevirtual

Returns whether the module is remotely executed in a worker instance.

Reimplemented from MLABModule.

◆ killWorker

void MLABRemoteModule::killWorker ( )
slot

Tries to kill worker process if it is managed by this process (this will silently fail if the process is not managed by this process).

◆ reload()

void MLABRemoteModule::reload ( )
overridevirtual

Reloads the module.

Reimplemented from MLABModule.

◆ requestStopProcessing

void MLABRemoteModule::requestStopProcessing ( )
slot

Sends a message to the worker that it should stop the current processing (this will set the global shouldStop flag in MLABGlobalEventFilter of the remote worker process, which is the same as pressing the global stop button in MeVisLab).

◆ shouldReload()

bool MLABRemoteModule::shouldReload ( )
inlineoverridevirtual

Returns whether the module should be reloaded.

Reimplemented from MLABModule.

◆ showWorker

void MLABRemoteModule::showWorker ( )
slot

Shows the IDE of worker process.

◆ workerPid

qint64 MLABRemoteModule::workerPid ( ) const
slot

Returns the process ID of the connected worker (also check isConnectedToSameHost too see if the process lives on the same host computer).