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 andSoRemoteVizClient.connectionParameters
.A
ConnectionParameters
object is passed to ServiceListener.onPendingCreateRenderArea and toServiceListener.onPendingShareRenderArea
.The application can also query this object from a
Connection
object. TheConnection
object can obtained in, e.g.,RenderAreaListener.onInitializedConnection()
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand
-
-
Field Summary
-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getIndex(java.lang.String key)
Gets the index associated with a key.java.lang.String
getKey(int index)
Gets the key associated with an index.int
getNumParameters()
Gets the number of parameters.java.lang.String
getValue(int index)
Gets the value of a parameter associated with an index.java.lang.String
getValue(java.lang.String key)
Gets the value of a parameter associated with a key.-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Method Detail
-
getNumParameters
public int getNumParameters()
Gets the number of parameters.- Returns:
- the number of parameters
-
getKey
public java.lang.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(java.lang.String key)
Gets the index associated with a key.- Returns:
- the index if the key exists, otherwise returns -1.
-
getValue
public java.lang.String getValue(java.lang.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 java.lang.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.
-
-