C# Class Org.Openengsb.XLinkCSharpClient.XLink.OpenEngSBConnectionManager

Manages the connect/disconnect to the OpenEngSB and the registration/deregistration to XLink.
Mostra file Open project: openengsb/sample-xlink-csharp-client Class Usage Examples

Public Methods

Method Description
connectToOpenEngSbWithXLink ( ) : void

Creates/Registers the connector at the OpenEngSB and registers the connector to XLink
createXLink ( WorkingDirectoryFile file ) : string

Creates a XLink to the given WorkingDirectoryFile and copies it to the clipboard. Aborts the creation if no connection to the OpenEngSB is established.
disconnect ( ) : void

Unregisters the connector from XLink and removes it from the OpenEngSB
getInstance ( ) : OpenEngSBConnectionManager

Returns the Connectors only instance.
initInstance ( String xlinkBaseUrl, String domainId, String programname, String hostIp, string classNameOfOpenEngSBModel, String openengsbContext ) : void

Initializes the Connectors only instance.
isConnected ( ) : bool
listOtherLocalInstalledSoftwareTools ( ) : void

List the other local software tools, currently using xlink.
setCurrentlyInstalledTools ( OOSourceCodeDomain newArryOfInstalledTools ) : void

Redefines the array with currently installed local software tools.
setCurrentlyInstalledTools ( OpenEngSBCore newArryOfInstalledTools ) : void

Redefines the array with currently installed local software tools.
triggerLocalSwitch ( String programname, String viewId, String filename ) : void

Triggers the local switching functionality for the given program, using the given viewId ontop of the defined file.

Private Methods

Method Description
OpenEngSBConnectionManager ( String xlinkServerURL, String domainId, String programname, String hostIp, string classNameOfOpenEngSBModel, String openengsbContext ) : System
convertBetweenDLLTypes ( OOSourceCodeDomain newArryOfInstalledTools ) : OpenEngSBCore.XLinkConnector[]

The DomainConnector and the OpenEngSBCore origin from different DLLs but they both contain the type XLinkConnector. This method converts between themm.
convertWorkingDirectoryFileToJSON ( WorkingDirectoryFile file ) : string

Converts a WorkingDirectoryFile instance to a OOCLass instance and serializes it to String, with JSON
findCurrentlyInstalledToolToName ( String programname ) : OpenEngSBCore.XLinkConnector

Returns the XLinkConnector entry to the given programname or null
findViewToCurrentlyInstalledTool ( OpenEngSBCore otherLocalTool, string viewId ) : OpenEngSBCore.XLinkConnectorView

Returns the XLinkConnectorView entry to the given XLinkConnector and viewId or null
initModelViewRelation ( ) : ModelToViewsTuple[]

Creates the Array of Model/View relations, offered by the Tool, for XLink
outputLine ( string line ) : void

Method Details

connectToOpenEngSbWithXLink() public method

Creates/Registers the connector at the OpenEngSB and registers the connector to XLink
public connectToOpenEngSbWithXLink ( ) : void
return void

createXLink() public method

Creates a XLink to the given WorkingDirectoryFile and copies it to the clipboard. Aborts the creation if no connection to the OpenEngSB is established.
public createXLink ( WorkingDirectoryFile file ) : string
file Org.Openengsb.XLinkCSharpClient.Model.WorkingDirectoryFile
return string

disconnect() public method

Unregisters the connector from XLink and removes it from the OpenEngSB
public disconnect ( ) : void
return void

getInstance() public static method

Returns the Connectors only instance.
public static getInstance ( ) : OpenEngSBConnectionManager
return OpenEngSBConnectionManager

initInstance() public static method

Initializes the Connectors only instance.
public static initInstance ( String xlinkBaseUrl, String domainId, String programname, String hostIp, string classNameOfOpenEngSBModel, String openengsbContext ) : void
xlinkBaseUrl String Link to OpenEngSB server
domainId String
programname String
hostIp String IP of the local host
classNameOfOpenEngSBModel string
openengsbContext String
return void

isConnected() public method

public isConnected ( ) : bool
return bool

listOtherLocalInstalledSoftwareTools() public method

List the other local software tools, currently using xlink.
public listOtherLocalInstalledSoftwareTools ( ) : void
return void

setCurrentlyInstalledTools() public method

Redefines the array with currently installed local software tools.
public setCurrentlyInstalledTools ( OOSourceCodeDomain newArryOfInstalledTools ) : void
newArryOfInstalledTools OOSourceCodeDomain
return void

setCurrentlyInstalledTools() public method

Redefines the array with currently installed local software tools.
public setCurrentlyInstalledTools ( OpenEngSBCore newArryOfInstalledTools ) : void
newArryOfInstalledTools OpenEngSBCore
return void

triggerLocalSwitch() public method

Triggers the local switching functionality for the given program, using the given viewId ontop of the defined file.
public triggerLocalSwitch ( String programname, String viewId, String filename ) : void
programname String
viewId String
filename String
return void