#include <WSCOVISEClient.h>

Inheritance diagram for covise::WSCOVISEClient:

Collaboration diagram for covise::WSCOVISEClient:

[legend]

Public Slots
bool	attach (const QString &endpoint="http://localhost:31111/")
	Attach to a running COVISE session. More...

bool	detach ()
	Detach from COVISE. More...

const QString &	getEndpoint () const

bool	isInExecute () const

void	setEventsAsSignal (bool on, bool alsoQueueRaw=false)
	Deliver events using signals. More...

void	setReadOnly (bool ro)
	Don't send changes to COVISE. More...

bool	isReadOnly () const

WSMap *	getMap () const
	Gets the current map of instantiated modules. More...

WSModule *	getModule (const QString &name, const QString &host) const
	Get an available module by name and host. More...

QList< WSModule * >	getModules (const QString &host) const
	Get all available modules for a host. More...

QStringList	getHosts () const
	Get all hosts currently in a session. More...

void	executeNet ()
	Execute the whole pipeline. More...

void	executeModule (const QString &moduleID)
	Execute a single module. More...

void	setParameterFromString (const QString &moduleID, const QString &parameter, const QString &value)
	Set a parameter using a string representation. More...

QString	getParameterAsString (const QString &moduleID, const QString &parameter)
	Get a parameter as string representation. More...

void	instantiateModule (const QString &module, const QString &host)
	Instantiate an available module on a certain host. More...

void	deleteModule (const QString &moduleID)
	Deletes an instantiated module. More...

void	link (const QString &fromModuleID, const QString &fromPort, const QString &toModuleID, const QString &toPort)

void	unlink (const QString &linkID)

void	openNet (const QString &filename)
	Open a map. More...

void	quit ()
	Quit COVISE. More...

covise::covise__Event *	takeEvent ()
	Check for events. More...

Signals
void	eventLink (const QString &fromModuleID, const QString &toModuleID)

void	eventUnlink (const QString &linkID)

void	eventModuleAdd (const QString &moduleID)

void	eventModuleDel (const QString &moduleID)

void	eventModuleDied (const QString &moduleID)

void	eventModuleChanged (const QString &moduleID)

void	eventModuleExecuteStart (const QString &moduleID)

void	eventModuleExecuteFinish (const QString &moduleID)

void	eventExecuteStart ()

void	eventExecuteFinish ()

void	eventParameterChanged (const QString &moduleID, const QString &name, const QString &value)

void	eventOpenNet (const QString &mapname)

void	eventOpenNetDone (const QString &mapname)

void	eventQuit ()

Public Member Functions
	WSCOVISEClient ()

virtual	~WSCOVISEClient ()

Properties
WSMap *	map

QString	endpoint

bool	inExecute

Private Slots
void	parameterChangeCB (covise::WSParameter *)

Private Member Functions
void	clearAvailableModules ()

virtual void	run ()

Private Attributes
QMap< QString, QList< covise::WSModule * > >	availableModules

covise::WSMap *	map

bool	attached

bool	keepRunning

QString	eventUUID

QQueue< covise::covise__Event * >	eventQueue

QMutex	eventQueueLock

bool	eventsAsSignal

bool	alsoQueueRaw

bool	readOnly

Constructor & Destructor Documentation

◆ WSCOVISEClient()

covise::WSCOVISEClient::WSCOVISEClient ( )

◆ ~WSCOVISEClient()

covise::WSCOVISEClient::~WSCOVISEClient ( )

virtual

Member Function Documentation

◆ attach

bool covise::WSCOVISEClient::attach ( const QString & endpoint = "http://localhost:31111/" )

slot

Attach to a running COVISE session.

◆ clearAvailableModules()

void covise::WSCOVISEClient::clearAvailableModules ( )

private

◆ deleteModule

void covise::WSCOVISEClient::deleteModule ( const QString & moduleID )

slot

Deletes an instantiated module.

◆ detach

bool covise::WSCOVISEClient::detach ( )

slot

Detach from COVISE.

◆ eventExecuteFinish

void covise::WSCOVISEClient::eventExecuteFinish ( )

signal

◆ eventExecuteStart

void covise::WSCOVISEClient::eventExecuteStart ( )

signal

◆ eventLink

void covise::WSCOVISEClient::eventLink	(	const QString &	fromModuleID,
		const QString &	toModuleID
	)

signal

◆ eventModuleAdd

void covise::WSCOVISEClient::eventModuleAdd ( const QString & moduleID )

signal

◆ eventModuleChanged

void covise::WSCOVISEClient::eventModuleChanged ( const QString & moduleID )

signal

◆ eventModuleDel

void covise::WSCOVISEClient::eventModuleDel ( const QString & moduleID )

signal

◆ eventModuleDied

void covise::WSCOVISEClient::eventModuleDied ( const QString & moduleID )

signal

◆ eventModuleExecuteFinish

void covise::WSCOVISEClient::eventModuleExecuteFinish ( const QString & moduleID )

signal

◆ eventModuleExecuteStart

void covise::WSCOVISEClient::eventModuleExecuteStart ( const QString & moduleID )

signal

◆ eventOpenNet

void covise::WSCOVISEClient::eventOpenNet ( const QString & mapname )

signal

◆ eventOpenNetDone

void covise::WSCOVISEClient::eventOpenNetDone ( const QString & mapname )

signal

◆ eventParameterChanged

void covise::WSCOVISEClient::eventParameterChanged	(	const QString &	moduleID,
		const QString &	name,
		const QString &	value
	)

signal

◆ eventQuit

void covise::WSCOVISEClient::eventQuit ( )

signal

◆ eventUnlink

void covise::WSCOVISEClient::eventUnlink ( const QString & linkID )

signal

◆ executeModule

void covise::WSCOVISEClient::executeModule ( const QString & moduleID )

slot

Execute a single module.

◆ executeNet

void covise::WSCOVISEClient::executeNet ( )

slot

Execute the whole pipeline.

◆ getEndpoint

const QString & covise::WSCOVISEClient::getEndpoint ( ) const

inlineslot

◆ getHosts

QStringList covise::WSCOVISEClient::getHosts ( ) const

slot

Get all hosts currently in a session.

◆ getMap

covise::WSMap * covise::WSCOVISEClient::getMap ( ) const

slot

Gets the current map of instantiated modules.

◆ getModule

covise::WSModule * covise::WSCOVISEClient::getModule	(	const QString &	name,
		const QString &	host
	)		const

slot

Get an available module by name and host.

◆ getModules

QList< covise::WSModule * > covise::WSCOVISEClient::getModules ( const QString & host ) const

slot

Get all available modules for a host.

◆ getParameterAsString

QString covise::WSCOVISEClient::getParameterAsString	(	const QString &	moduleID,
		const QString &	parameter
	)

slot

Get a parameter as string representation.

◆ instantiateModule

void covise::WSCOVISEClient::instantiateModule	(	const QString &	module,
		const QString &	host
	)

slot

Instantiate an available module on a certain host.

◆ isInExecute

bool covise::WSCOVISEClient::isInExecute ( ) const

slot

◆ isReadOnly

bool covise::WSCOVISEClient::isReadOnly ( ) const

slot

◆ link

void covise::WSCOVISEClient::link	(	const QString &	fromModuleID,
		const QString &	fromPort,
		const QString &	toModuleID,
		const QString &	toPort
	)

slot

◆ openNet

void covise::WSCOVISEClient::openNet ( const QString & filename )

slot

Open a map.

◆ parameterChangeCB

void covise::WSCOVISEClient::parameterChangeCB ( covise::WSParameter * p )

privateslot

◆ quit

void covise::WSCOVISEClient::quit ( )

slot

Quit COVISE.

◆ run()

void covise::WSCOVISEClient::run ( )

privatevirtual

◆ setEventsAsSignal

void covise::WSCOVISEClient::setEventsAsSignal	(	bool	on,
		bool	alsoQueueRaw = `false`
	)

slot

Deliver events using signals.

◆ setParameterFromString

void covise::WSCOVISEClient::setParameterFromString	(	const QString &	moduleID,
		const QString &	parameter,
		const QString &	value
	)

slot

Set a parameter using a string representation.

◆ setReadOnly

void covise::WSCOVISEClient::setReadOnly ( bool ro )

slot

Don't send changes to COVISE.

◆ takeEvent

covise::covise__Event * covise::WSCOVISEClient::takeEvent ( )

slot

Check for events.

◆ unlink

void covise::WSCOVISEClient::unlink ( const QString & linkID )

slot

Member Data Documentation

◆ alsoQueueRaw

bool covise::WSCOVISEClient::alsoQueueRaw

private

◆ attached

bool covise::WSCOVISEClient::attached

private

◆ availableModules

QMap<QString, QList<covise::WSModule *> > covise::WSCOVISEClient::availableModules

private

◆ eventQueue

QQueue<covise::covise__Event *> covise::WSCOVISEClient::eventQueue

private

◆ eventQueueLock

QMutex covise::WSCOVISEClient::eventQueueLock

private

◆ eventsAsSignal

bool covise::WSCOVISEClient::eventsAsSignal

private

◆ eventUUID

QString covise::WSCOVISEClient::eventUUID

private

◆ keepRunning

bool covise::WSCOVISEClient::keepRunning

private

◆ map

covise::WSMap* covise::WSCOVISEClient::map

private

◆ readOnly

bool covise::WSCOVISEClient::readOnly

private

Property Documentation

◆ endpoint

QString covise::WSCOVISEClient::endpoint

read

◆ inExecute

bool covise::WSCOVISEClient::inExecute

read

◆ map

WSMap * covise::WSCOVISEClient::map

read

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

wslib/WSCOVISEClient.h
wslib/WSCOVISEClient.cpp

Public Slots

Signals

Public Member Functions

Properties

Private Slots

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ WSCOVISEClient()

◆ ~WSCOVISEClient()

Member Function Documentation

◆ attach

◆ clearAvailableModules()

◆ deleteModule

◆ detach

◆ eventExecuteFinish

◆ eventExecuteStart

◆ eventLink

◆ eventModuleAdd

◆ eventModuleChanged

◆ eventModuleDel

◆ eventModuleDied

◆ eventModuleExecuteFinish

◆ eventModuleExecuteStart

◆ eventOpenNet

◆ eventOpenNetDone

◆ eventParameterChanged

◆ eventQuit

◆ eventUnlink

◆ executeModule

◆ executeNet

◆ getEndpoint

◆ getHosts

◆ getMap

◆ getModule

◆ getModules

◆ getParameterAsString

◆ instantiateModule

◆ isInExecute

◆ isReadOnly

◆ link

◆ openNet

◆ parameterChangeCB

◆ quit

◆ run()

◆ setEventsAsSignal

◆ setParameterFromString

◆ setReadOnly

◆ takeEvent

◆ unlink

Member Data Documentation

◆ alsoQueueRaw

◆ attached

◆ availableModules

◆ eventQueue

◆ eventQueueLock

◆ eventsAsSignal

◆ eventUUID

◆ keepRunning

◆ map

◆ readOnly

Property Documentation

◆ endpoint

◆ inExecute

◆ map