Package com.openinventor.remoteviz.rendering

Class ConnectionParameters

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.remoteviz.rendering.ConnectionParameters
public class ConnectionParameters extends Inventor
Field-value pairs included in the URL when the client requested a connection. See RemoteVizRenderArea.connectTo and SoRemoteVizClient.connectionParameters.

A ConnectionParameters object is passed to ServiceListener.onPendingCreateRenderArea and to ServiceListener.onPendingShareRenderArea.

The application can also query this object from a Connection object. The Connection object can obtained in, e.g., RenderAreaListener.onInitializedConnection().

  • Method Details

    • getNumParameters

      public int getNumParameters()
      Gets the number of parameters.

      Returns:
      the number of parameters

    • getKey

      public String getKey(int index)
      Gets the key associated with an index.

      Parameters:
      index - : the parameter index. Range id [0..getNumParameters - 1]

      Returns:
      the key if the index exists, otherwise returns an empty string.

    • getIndex

      public int getIndex(String key)
      Gets the index associated with a key.

      Returns:
      the index if the key exists, otherwise returns -1.

    • getValue

      public String getValue(String key)
      Gets the value of a parameter associated with a key.

      Parameters:
      key - : the key

      Returns:
      the value if the key exists, otherwise returns an empty string.

    • getValue

      public String getValue(int index)
      Gets the value of a parameter associated with an index.

      Parameters:
      index - : the parameter index. Range id [0..getNumParameters - 1]

      Returns:
      the value if the index exists, otherwise returns an empty string.