ApiUrl Struct Reference

FPGA Manager device URL More...

#include <FpgaManager_Types.h>

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

Public Member Functions
const std::string &	str () const
	String representation of the Device URL More...
Protocol	protocol () const
	Transport Protocol of the Device URL More...

Static Public Member Functions
static ApiUrl	UDP (const std::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	FX3Default ()
	The default FX3 URL for Enclustra Reference Designs More...
static ApiUrl	FTDI (const std::string &serialNo)
	Create an USB2 FTDI Transport URL based on the FTDI serial number More...
static ApiUrl	PCIeDefault ()
	The default PCIe device URL More...
static ApiUrl	PCIe (int deviceIndex)
	Create a PCIe Transport URL based on the device index More...
static ApiUrl	Parse (const std::string &url)
	Create an URL object based on a FPGA Manager URL string More...

Detailed Description

FPGA Manager device URL

Member Enumeration Documentation

Protocol

enum Protocol

strong

Transport Protocol

Member Function Documentation

FTDI()

static ApiUrl FTDI ( const std::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

FX3Default()

static ApiUrl FX3Default ( )

static

The default FX3 URL for Enclustra Reference Designs

Returns

ApiUrl object

Parse()

static ApiUrl Parse ( const std::string &  url )

static

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

PCIeDefault()

static ApiUrl PCIeDefault ( )

static

The default PCIe device URL

Returns

ApiUrl object

protocol()

Protocol protocol

(

)

const

Transport Protocol of the Device URL

Returns

Transport Protocol

str()

const std::string& str

(

)

const

String representation of the Device URL

Returns

URL as string

UDP()

static ApiUrl UDP ( const std::string &  ipString )

static

Create an UDP Transport URL based on an IP Address

Parameters

ipString

IP Address

Returns

ApiUrl object

---

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

• C:/Git/Ip/en_mgr_sw/Projects/Win7/CppApi/public/FpgaManager_Types.h