RemoteNetwork handles and manipulates Multiuser remote networks. More...

Inheritance diagram for RemoteNetwork:

Public Member Functions
bool	connect (QString, int, QString, QString)
	Makes a Multiuser connection to a peer remote network. More...

void	disconnect ()
	Disconnects the Multiuser connection. More...

bool	isConnected ()
	Returns true if the remote network is connected, otherwise false. More...

void	peerConnected ()
	This event is emitted when the remote network gets connected. More...

void	peerDisconnected ()
	This event is emitted when the remote network gets disconnected. More...

void	setPeerAddress (QString)
	Sets the peer address for the outgoing connection. More...

QString	getPeerAddress ()
	Returns the peer address for the outgoing connection. More...

void	setPortNumber (int)
	Sets the peer port number for the outgoing connection. More...

int	getPortNumber ()
	Returns the peer port number for the outgoing connection. More...

void	setConnectAsUserName (QString)
	Sets the user name entered when making the outgoing connection. More...

QString	getConnectAsUserName ()
	Returns the peer network name for the outgoing connection. More...

void	setPassword (QString)
	Sets the peer password for the outgoing connection. More...

QString	getPassword ()
	Returns the peer password for the outgoing connection. More...

void	setMode (bool)
	Sets the Multiuser connection type to outgoing or incoming. More...

bool	isOutgoing ()
	Returns true if the remote network is set to outgoing connection, false if incoming connection. More...

Public Member Functions inherited from Device
void	setName (QString)
	Sets the display name of this device. More...

QString	getName ()
	Returns the display name of this device. More...

void	nameChanged (QString, QString)
	IPC event. More...

void	setPower (bool)
	Sets the power on or off. More...

void	addSound (QString, QString)
	Adds sound to the device. More...

void	playSound (QString, int)
	Play sound to the device. More...

void	stopSound (QString)
	Stop playing sound on the device. More...

void	stopSounds ()
	Stops playing all sounds on the device. More...

void	destroySounds ()
	Destroy all of the sounds on the device. More...

bool	getPower ()
	Returns the current power state of this device. More...

double	getXCoordinate ()
	Returns the current x-coordinate position in the Logical workspace for this device. More...

double	getYCoordinate ()
	Returns the current y-coordinate position in the Logical workspace for this device. More...

double	getCenterXCoordinate ()
	Returns the current x-coordinate position in the Logical workspace for this device. More...

double	getCenterYCoordinate ()
	Returns the current y-coordinate position in the Logical workspace for this device. More...

double	getAreaTopY ()
	Returns the current topmost y-coordinate position in the for this device. More...

double	getAreaLeftX ()
	Returns the current leftmost x-coordinate position in the for this device. More...

bool	moveToLocationCentered (int, int)
	Moves this device to the specified location for its center in Logical workspace. More...

bool	moveToLocation (int, int)
	Moves this device to the specified location in Logical workspace. More...

int	getXPhysicalWS ()
	Returns the current x-coordinate position in the Physical workspace for this device. More...

int	getYPhysicalWS ()
	Returns the current y-coordinate position in the Physical workspace for this device. More...

double	getGlobalXPhysicalWS ()
	Returns the current global x-coordinate position in the Physical workspace for this device. More...

double	getGlobalYPhysicalWS ()
	Returns the current global y-coordinate position in the Physical workspace for this device. More...

bool	moveToLocInPhysicalWS (int, int)
	Moves this device to the specified location in Physical workspace. More...

bool	moveByInPhysicalWS (int, int)
	Moves this device by the specified amount in Physical workspace. More...

void	powerChanged (bool)
	IPC event. More...

void	poweringOff ()
	IPC event. More...

DeviceType	getType ()
	Returns the type of this device. More...

string	getModel ()
	Returns the model of this device. More...

DeviceDescriptor	getDescriptor ()
	Returns the device descriptor that user can get information on the device like type, model, module supported.. More...

string	getSerialNumber ()
	Returns the device serial number. More...

Port	getPort (string)
	Returns the Port object with the specified port name. More...

int	getPortCount ()
	Returns the number of ports in this device. More...

Port	getPortAt (int)
	Returns the Port object at the specified index. More...

Process	getProcess (string)
	Returns the Process object associated the process name. More...

int	getUsbPortCount ()
	Return the number of usb port. More...

UsbPort	getUsbPortAt (int)
	Returns the usb port at a specified index. More...

Module	getRootModule ()
	Returns the root module of the device. More...

bool	addModule (string, ModuleType, string)
	Adds a specific module to a particular slot. More...

bool	removeModule (string)
	Removes the module from the slot. More...

void	moduleAdded (ModuleType, string, string)
	This event is emitted when a module is added. More...

void	moduleRemoved (ModuleType, string, string)
	This event is emitted when a module is removed. More...

void	portAdded (string)
	This event is emitted when a port is added. More...

void	portRemoved (string)
	This event is emitted when a port is removed. More...

void	portRemoving (string)
	This event is emitted when a port is being removed but before it is actually removed. This is useful for script modules to clean up things before the port is removed. More...

TerminalLine	getCommandLine ()
	Returns the command line TerminalLine object. More...

void	addCustomVar (QString, QString)
	Adds a custom variable. More...

bool	removeCustomVar (QString)
	Removes a custom variable. More...

bool	hasCustomVar (QString)
	Returns true if this device has a custom variable with the specified name. More...

QString	getCustomVarStr (QString)
	Returns the value of the variable with the specified name. More...

int	getCustomVarsCount ()
	Returns the number of custom variables this device has. More...

QString	getCustomVarNameAt (int)
	Returns the name of the custom variable at the specified index. More...

QString	getCustomVarValueStrAt (int)
	Returns the value of the custom variable at the specified index. More...

void	setCustomInterface (QString)
	Set custom interface to the device. More...

QString	getCustomInterface ()
	Get custom interface name on the device. More...

QString	serializeToXml ()
	Returns the serialization string of this device. More...

QString	activityTreeToXml ()
	Returns the serialization string of this device's activity tree. More...

PhysicalObject	getPhysicalObject ()
	Get custom interface name on the device. More...

QString	getCustomLogicalImage ()
	Get custom logical image path. More...

void	setCustomLogicalImage (QString)
	Set custom logical image path. More...

QString	getCustomPhysicalImage ()
	Get custom physical image path. More...

void	setCustomPhysicalImage (QString)
	Set custom physical image path. More...

vector< string >	getSupportedModule ()
	Get a vector of supported modules. More...

void	setTime (int, int, int, int, int, int)
	Set time to the device. More...

long	getUpTime ()
	Set time to the device. More...

vector< string >	getPorts ()
	Set time to the device. More...

double	getDeviceExternalAttributeValue (string)
	Get device external attribute value. More...

void	setDeviceExternalAttributes (QString)
	Set device external attribute value. More...

void	addDeviceExternalAttributes (QString)
	Add device external attribute value. More...

void	subtractDeviceExternalAttributes (QString)
	Remove some of the device external attribute value pairs from the current list. More...

QString	getDeviceExternalAttributes ()
	Returns the list of external attributes and associated values. More...

void	clearDeviceExternalAttributes ()

bool	isOutdated ()

bool	restoreToDefault (bool, bool)

void	updateTemplateCreationTime ()

bool	runProject (string, string)
	Runs a programming project in the mcu. More...

bool	stopProject (string)
	Stops a programming project in the mcu. More...

bool	isProjectRunning (string)
	Checks if a programming project with the given name is running. More...

bool	runCodeInProject (string, string)
	Runs additional code in the given project. More...

void	addProgrammingSerialOutputs (string)
	Writes to the programming output. Text appears in the programming output dialog. More...

string	getProgrammingSerialOutputs ()
	Gets the programming output. It is the text that appears in the programming output dialog. More...

void	clearProgrammingSerialOutputs ()
	Clears the programming output dialog. More...

UserDesktopAppConfig	addUserDesktopApp (string)

UserDesktopAppConfig	addUserDesktopAppFrom (UserDesktopAppConfig)

UserDesktopAppConfig	addUserDesktopAppFromGlobal (string)

int	getUserDesktopAppCount ()

UserDesktopAppConfig	getUserDesktopAppAt (int)

UserDesktopAppConfig	getUserDesktopAppByDir (string)

UserDesktopAppConfig	getUserDesktopAppById (string)

void	removeUserDesktopApp (string)

void	relinkUserDesktopApp (string, string)

bool	isDesktopAvailable ()

Detailed Description

RemoteNetwork handles and manipulates Multiuser remote networks.

Member Function Documentation

◆ connect()

bool RemoteNetwork::connect	(	QString	,
		int	,
		QString	,
		QString
	)

Makes a Multiuser connection to a peer remote network.

Parameters

peerAddress,the	peer address of the peer remote network.
peerPort,the	peer port number of the peer remote network.
userName,the	peer network name of the peer remote network.
password,the	peer password of the peer remote network.

Returns: bool, true if successful, otherwise false.

◆ disconnect()

void RemoteNetwork::disconnect ( )

Disconnects the Multiuser connection.

◆ getConnectAsUserName()

QString RemoteNetwork::getConnectAsUserName ( )

Returns the peer network name for the outgoing connection.

Returns: QString, the peer network name for the outgoing connection.

◆ getPassword()

QString RemoteNetwork::getPassword ( )

Returns the peer password for the outgoing connection.

Returns: QString, the peer password for the outgoing connection.

◆ getPeerAddress()

QString RemoteNetwork::getPeerAddress ( )

Returns the peer address for the outgoing connection.

Returns: QString, the peer address for the outgoing connection.

◆ getPortNumber()

int RemoteNetwork::getPortNumber ( )

Returns the peer port number for the outgoing connection.

Returns: int, the peer port number for the outgoing connection.

◆ isConnected()

bool RemoteNetwork::isConnected ( )

Returns true if the remote network is connected, otherwise false.

Returns: bool, true if the remote network is connected, otherwise false.

◆ isOutgoing()

bool RemoteNetwork::isOutgoing ( )

Returns true if the remote network is set to outgoing connection, false if incoming connection.

Returns: bool, true if the remote network is set to outgoing connection, false if incoming connection.

◆ peerConnected()

void RemoteNetwork::peerConnected ( )

This event is emitted when the remote network gets connected.

IPC event.

◆ peerDisconnected()

void RemoteNetwork::peerDisconnected ( )

This event is emitted when the remote network gets disconnected.

IPC event.

◆ setConnectAsUserName()

void RemoteNetwork::setConnectAsUserName ( QString )

Sets the user name entered when making the outgoing connection.

Parameters

username,the username to use.

◆ setMode()

void RemoteNetwork::setMode ( bool )

Sets the Multiuser connection type to outgoing or incoming.

Parameters

bOutgoing,true for outgoing connection, false for incoming connection.

◆ setPassword()

void RemoteNetwork::setPassword ( QString )

Sets the peer password for the outgoing connection.

Parameters

password,the peer password for the outgoing connection.

◆ setPeerAddress()

void RemoteNetwork::setPeerAddress ( QString )

Sets the peer address for the outgoing connection.

Parameters

address,the peer address for the outgoing connection.

◆ setPortNumber()

void RemoteNetwork::setPortNumber ( int )

Sets the peer port number for the outgoing connection.

Parameters

port,the peer port number for the outgoing connection.

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

CMURemoteNetwork.pki

Public Member Functions

Detailed Description

Member Function Documentation

◆ connect()

◆ disconnect()

◆ getConnectAsUserName()

◆ getPassword()

◆ getPeerAddress()

◆ getPortNumber()

◆ isConnected()

◆ isOutgoing()

◆ peerConnected()

◆ peerDisconnected()

◆ setConnectAsUserName()

◆ setMode()

◆ setPassword()

◆ setPeerAddress()

◆ setPortNumber()