Visioscan Set SDK Libraries 1.0.14
Visioscan Set SDK Help documentation file for C++ and C++/CLI
 
Loading...
Searching...
No Matches
UsbSettings Class Reference

The USB settings encapsulation for USB communication. More...

#include <UsbSettings.h>

Inheritance diagram for UsbSettings:

Public Member Functions

 UsbSettings ()
 Base constructor.
 
 UsbSettings (unsigned int vendorId, unsigned int productId, unsigned int readChannel, unsigned int writeChannel)
 Copy constructor.
 
 ~UsbSettings ()
 Destructor.
 
unsigned int GetVendorId ()
 Gets the device's vendor identifier.
 
unsigned int GetProductId ()
 Gets the device's product identifier.
 
unsigned int GetReadChannel ()
 Get the device's input channel.
 
unsigned int GetWriteChannel ()
 Gets the device output channel.
 
void SetVendorId (unsigned int vendorId)
 Sets the device's vendor identifier.
 
void SetProductId (unsigned int productId)
 Sets the device's product identifier.
 
void SetReadChannel (unsigned int inputChannel)
 Sets the device's input channel.
 
void SetWriteChannel (unsigned int outputChannel)
 Sets the device's output channel.
 

Detailed Description

The USB settings encapsulation for USB communication.

Constructor & Destructor Documentation

◆ UsbSettings() [1/2]

UsbSettings::UsbSettings ( )

Base constructor.

◆ UsbSettings() [2/2]

UsbSettings::UsbSettings ( unsigned int  vendorId,
unsigned int  productId,
unsigned int  readChannel,
unsigned int  writeChannel 
)

Copy constructor.

Parameters
vendorIdThe hardware vendor identifier
productIdThe hardware product identifier
writeChannelThe device's channel identifier on which command must be sent
readChannelThe device's channel identifier on which ackowledgments and raw data will be sent

◆ ~UsbSettings()

UsbSettings::~UsbSettings ( )

Destructor.

Member Function Documentation

◆ GetProductId()

unsigned int UsbSettings::GetProductId ( )

Gets the device's product identifier.

Returns
The device's product identifier

◆ GetReadChannel()

unsigned int UsbSettings::GetReadChannel ( )

Get the device's input channel.

Returns
The device's input channel

◆ GetVendorId()

unsigned int UsbSettings::GetVendorId ( )

Gets the device's vendor identifier.

Returns
The device's vendor identifier

◆ GetWriteChannel()

unsigned int UsbSettings::GetWriteChannel ( )

Gets the device output channel.

Returns
The device's ouput channel

◆ SetProductId()

void UsbSettings::SetProductId ( unsigned int  productId)

Sets the device's product identifier.

Parameters
vendorIdThe device's prodict identifier

◆ SetReadChannel()

void UsbSettings::SetReadChannel ( unsigned int  inputChannel)

Sets the device's input channel.

Parameters
vendorIdThe device's input channel

◆ SetVendorId()

void UsbSettings::SetVendorId ( unsigned int  vendorId)

Sets the device's vendor identifier.

Parameters
vendorIdThe device's vendor identifier

◆ SetWriteChannel()

void UsbSettings::SetWriteChannel ( unsigned int  outputChannel)

Sets the device's output channel.

Parameters
vendorIdThe device's output channel

The documentation for this class was generated from the following files: