Skip to content

com.inscoper.api.ConnectionDescription

ConnectionDescription class provides connection information coming from the device controller. More...

Public Functions

Name
synchronized void delete()
ConnectionDescription()
Default constructor.
int getTag()
Get the tag of the connection.
void setTag(int tag)
Set the tag of the connection.
EConnectionTypeDesc getType()
Get the type of the connection.
void setType(EConnectionTypeDesc type)
Set the type of the connection.
String getDescription()
Get the description of the connection.
void setDescription(String description)
Set the description of the connection.

Protected Functions

Name
ConnectionDescription(long cPtr, boolean cMemoryOwn)
void swigSetCMemOwn(boolean own)
void finalize()
long getCPtr(ConnectionDescription obj)

Detailed Description

public class com.inscoper.api.ConnectionDescription;

ConnectionDescription class provides connection information coming from the device controller.

This class encapsulates details about a device connection, such as its tag, type, and a textual description, as reported by the device controller.

Public Functions Documentation

function delete

public synchronized void delete()

function ConnectionDescription

public ConnectionDescription()

Default constructor.

Initializes a new instance of the ConnectionDescription class.

function getTag

public int getTag()

Get the tag of the connection.

Return: The tag of the connection

Retrieves the unique tag of the connection.

function setTag

public void setTag(
    int tag
)

Set the tag of the connection.

Parameters:

  • tag : The tag of the connection

Sets the unique tag of the connection.

function getType

public EConnectionTypeDesc getType()

Get the type of the connection.

Return: The type of the connection

Retrieves the type of the connection (e.g., Serial, USB).

function setType

public void setType(
    EConnectionTypeDesc type
)

Set the type of the connection.

Parameters:

  • type : The type of the connection

Sets the type of the connection.

function getDescription

public String getDescription()

Get the description of the connection.

Return: The description of the connection

Retrieves the textual description of the connection.

function setDescription

public void setDescription(
    String description
)

Set the description of the connection.

Parameters:

  • description : The description of the connection

Sets the textual description of the connection.

Protected Functions Documentation

function ConnectionDescription

protected ConnectionDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

function finalize

protected void finalize()

function getCPtr

protected static long getCPtr(
    ConnectionDescription obj
)

Updated on 2026-04-02 at 10:55:37 +0200