com.inscoper.api.USBConnectionConfig¶

USBConnectionConfig class provides required information for USB devices configuration. More...

Inherits from com.inscoper.api.ConnectionConfig

Public Functions¶

	Name
synchronized void	delete()
	USBConnectionConfig() Default constructor.
void	fromXML(XMLNode connectionNode) Provide USB connection information from the XML node.
void	toXML(XMLNode xmlParent) Export USB connection information in an XML node attached to the parent XML node.
EConnectionType	getType() Return the type of connection.
long	getMatchBitField() Get the bit field.
void	setMatchBitField(long matchBitField) Set the bit field.
int	getVid() Get the VID.
void	setVid(int vid) Set the VID.
int	getPid() Get the PID.
void	setPid(int pid) Set the PID.
String	getManufacturer() Get the manufacturer name.
void	setManufacturer(String manufacturer) Set the manufacturer name.
String	getProduct() Get the product name.
void	setProduct(String product) Set the product name.
String	getSerialNumber() Get the serial number.
void	setSerialNumber(String serialNumber) Set the serial number.
String	getWaitingAns() Get the waiting answer.
void	setWaitingAns(String waitingAns) Set the waiting answer.
short	getNumInterface() Get the interface number.
void	setNumInterface(short numInterface) Set the interface number.
int	getSubDeviceTag() Get the sub-device tag.
void	setSubDeviceTag(int subDeviceTag) Set the sub-device tag.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.api.ConnectionConfig

	Name
	ConnectionConfig() Constructor.
	ConnectionConfig(short tag) Constructor.
int	getTag() Get the tag of the current connection.
void	setTag(int tag) Set the tag of the current connection.
int	getRealType()
ConnectionConfig	createProxy(long cPtr, boolean cMemoryOwn)
AdvancedConnectionConfig	castToAdvancedConnectionConfig(ConnectionConfig connectionConfig)
USBConnectionConfig	castToUSBConnectionConfig(ConnectionConfig connectionConfig)
EthernetConnectionConfig	castToEthernetConnectionConfig(ConnectionConfig connectionConfig)

Protected Functions inherited from com.inscoper.api.ConnectionConfig

	Name
	ConnectionConfig(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.api.USBConnectionConfig;

USBConnectionConfig class provides required information for USB devices configuration.

Note: This class is non-copyable and non-movable.

This class extends ConnectionConfig to manage USB-specific settings including Vendor ID (VID), Product ID (PID), serial number.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.ConnectionConfig.delete

function USBConnectionConfig¶

public USBConnectionConfig()

Default constructor.

Initializes a new instance of the USBConnectionConfig class.

function fromXML¶

public void fromXML(
    XMLNode connectionNode
)

Provide USB connection information from the XML node.

Parameters:

connectionNode : The XML node containing USB connection information

Exceptions:

InscoperException If an error occurred

Reimplements: com.inscoper.api.ConnectionConfig.fromXML

Populates the USB connection configuration from the provided XML node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

Export USB connection information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurred

Reimplements: com.inscoper.api.ConnectionConfig.toXML

Serializes the USB connection configuration to the specified parent XML node.

function getType¶

public EConnectionType getType()

Return the type of connection.

Return: The type of connection

Reimplements: com.inscoper.api.ConnectionConfig.getType

Retrieves the specific type of connection configuration (USB).

function getMatchBitField¶

public long getMatchBitField()

Get the bit field.

Return: The bit field

Retrieves the bit field used to identify the USB device among those connected to the device controller.

function setMatchBitField¶

public void setMatchBitField(
    long matchBitField
)

Set the bit field.

Parameters:

matchBitField The bit field to set

Sets the bit field used to identify the USB device among those connected to the device controller.

Bit field definitions:

MATCH_USB_VID 0x00000001
MATCH_USB_PID 0x00000002
MATCH_USB_IMANUFACTURER 0x00000004
MATCH_USB_IPRODUCT 0x00000008
MATCH_USB_ISERIALNUMBER 0x00000010
MATCH_USB_FUNCTION 0x00000020
MATCH_USB_NUM_INTERFACE 0x00000040

function getVid¶

public int getVid()

Get the VID.

Return: The VID

Retrieves the Vendor ID (VID) of the USB device.

function setVid¶

public void setVid(
    int vid
)

Set the VID.

Parameters:

vid : The VID

Sets the Vendor ID (VID) of the USB device.

function getPid¶

public int getPid()

Get the PID.

Return: The PID

Retrieves the Product ID (PID) of the USB device.

function setPid¶

public void setPid(
    int pid
)

Set the PID.

Parameters:

pid : The PID

Sets the Product ID (PID) of the USB device.

function getManufacturer¶

public String getManufacturer()

Get the manufacturer name.

Return: The manufacturer name

Retrieves the manufacturer name of the USB device.

function setManufacturer¶

public void setManufacturer(
    String manufacturer
)

Set the manufacturer name.

Parameters:

manufacturer : The manufacturer name

Sets the manufacturer name of the USB device.

function getProduct¶

public String getProduct()

Get the product name.

Return: The product name

Retrieves the product name of the USB device.

function setProduct¶

public void setProduct(
    String product
)

Set the product name.

Parameters:

product : The product name

Sets the product name of the USB device.

function getSerialNumber¶

public String getSerialNumber()

Get the serial number.

Return: The serial number

Retrieves the serial number of the USB device.

function setSerialNumber¶

public void setSerialNumber(
    String serialNumber
)

Set the serial number.

Parameters:

serialNumber : The serial number

Sets the serial number of the USB device.

function getWaitingAns¶

public String getWaitingAns()

Get the waiting answer.

Return: The waiting answer

Retrieves the expected response string (to differentiate devices with identical USB parameters).

function setWaitingAns¶

public void setWaitingAns(
    String waitingAns
)

Set the waiting answer.

Parameters:

waitingAns : The waiting answer

Sets the expected response string (to differentiate devices with identical USB parameters).

function getNumInterface¶

public short getNumInterface()

Get the interface number.

Return: The interface number

Retrieves the interface number on the USB device.

function setNumInterface¶

public void setNumInterface(
    short numInterface
)

Set the interface number.

Parameters:

numInterface : The interface number

Sets the interface number on the USB device.

function getSubDeviceTag¶

public int getSubDeviceTag()

Get the sub-device tag.

Return: The sub-device tag

Retrieves the tag of the sub-device used to differentiate devices with identical USB parameters.

function setSubDeviceTag¶

public void setSubDeviceTag(
    int subDeviceTag
)

Set the sub-device tag.

Parameters:

subDeviceTag : The sub-device tag

Sets the tag of the sub-device used to differentiate devices with identical USB parameters.

Protected Functions Documentation¶

function USBConnectionConfig¶

protected USBConnectionConfig(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.ConnectionConfig.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.ConnectionConfig.finalize

function getCPtr¶

protected static long getCPtr(
    USBConnectionConfig obj
)

Updated on 2026-09-03 at 12:14:19 +0200