ApiUrl Struct Reference

FPGA Manager device URL More...

Public Types
enum	Protocol_e { Unknown, UDP, USB2, USB3, PCIe }
	Transport Protocol More...

Public Member Functions
override string	ToString ()
	String conversion More...

Static Public Member Functions
static ApiUrl	UDP (IPAddress ipAddress)
	Create an UDP Transport URL based on an IP Address More...
static ApiUrl	UDP (string ipString)
	Create an UDP Transport URL based on an IP Address More...
static ApiUrl	FX3 (int vendor, int product)
	Create an USB3 FX3 Transport URL based on FX3 vendor and product id. More...
static ApiUrl	FX3 (int vendor, int product, int index)
	Create an USB3 FX3 Transport URL based on FX3 vendor, product id and index. More...
static ApiUrl	FTDI (string serialNo)
	Create an USB2 FTDI Transport URL based on the FTDI serial number More...
static ApiUrl	PCIe (int deviceIndex)
	Create a PCIe Transport URL based on the device index More...
static ApiUrl	Parse (string url)
	Create an URL object based on a FPGA Manager URL string More...

Static Public Attributes
static ApiUrl	FX3Default => FX3(0x204A, 0x1001)
	The default FX3 URL for Enclustra Reference Designs More...
static ApiUrl	PCIeDefault => PCIe(0)
	The default PCIe device URL More...

Properties
Protocol_e	Protocol [get]
	Transport Protocol More...

Detailed Description

FPGA Manager device URL

Member Enumeration Documentation

Protocol_e

enum Protocol_e

strong

Transport Protocol

Member Function Documentation

FTDI()

static ApiUrl FTDI ( string  serialNo )

static

Create an USB2 FTDI Transport URL based on the FTDI serial number

Parameters

serialNo

Serial number of the FTDI device

Returns

ApiUrl object

FX3() [1/2]

static ApiUrl FX3 ( int  vendor, int  product  )

static

Create an USB3 FX3 Transport URL based on FX3 vendor and product id.

Parameters

vendor	Vendor ID
product	Product ID

Returns

ApiUrl object

FX3() [2/2]

static ApiUrl FX3 ( int  vendor, int  product, int  index  )

static

Create an USB3 FX3 Transport URL based on FX3 vendor, product id and index.

Parameters

vendor	Vendor ID
product	Product ID
index	Zero based index

Returns

ApiUrl object

Parse()

static ApiUrl Parse ( string  url )

inlinestatic

Create an URL object based on a FPGA Manager URL string

Parameters

url	FPGA Manager device URL

Returns

ApiUrl object

PCIe()

static ApiUrl PCIe ( int  deviceIndex )

static

Create a PCIe Transport URL based on the device index

Parameters

deviceIndex

Zero based device index

Returns

ApiUrl object

ToString()

override string ToString

(

)

String conversion

Returns

URL as string

UDP() [1/2]

static ApiUrl UDP ( IPAddress  ipAddress )

inlinestatic

Create an UDP Transport URL based on an IP Address

Parameters

ipAddress

IP Address

Returns

ApiUrl object

UDP() [2/2]

static ApiUrl UDP ( string  ipString )

static

Create an UDP Transport URL based on an IP Address

Parameters

ipString

IP Address in dotted notation (IPV4)

Returns

ApiUrl object

Member Data Documentation

FX3Default

ApiUrl FX3Default => FX3(0x204A, 0x1001)

static

The default FX3 URL for Enclustra Reference Designs

PCIeDefault

ApiUrl PCIeDefault => PCIe(0)

static

The default PCIe device URL

Property Documentation

Protocol

Protocol_e Protocol

get

Transport Protocol

---

The documentation for this struct was generated from the following file:

• C:/Git/Ip/en_mgr_sw/Projects/Win7/CsApi/ApiUrl.cs