IFpgaManager Interface Reference

Provides access to the FPGA Manager API More...

Inheritance diagram for IFpgaManager:

Public Member Functions
void	Configure (Configuration.ConfigSettings settings)
	Updates the configuration with which all transport instances are configured from More...
Task	ConfigureAsync (Configuration.ConfigSettings settings)
	Updates the configuration with which all transport instances are configured from asynchronously More...
string	GetErrorTrace ()
	Error trace of the underlying FPGA Manager transport library More...
IMmAccess	CreateMemoryMap (int streamNo)
	Creates an interface for memory mapped access More...
Task< IMmAccess >	CreateMemoryMapAsync (int streamNo)
	Creates an interface for memory mapped access asynchronously More...
IStream	CreateStream (int streamNo, StreamType type, StreamDirection direction)
	Creates an interface for stream access More...
Task< IStream >	CreateStreamAsync (int streamNo, StreamType type, StreamDirection direction)
	Creates an interface for stream access asynchronously More...
void	Open ()
	Opens the device and all previously created streams More...
Task	OpenAsync ()
	Opens the device and all previously created streams asynchronously More...

Properties
bool	IsOpen [get]
	Is true if the FPGA Manager connection has been opened
ApiDetails	Details [get]
	Details of the FPGA Manager libraries More...
ApiUrl	Url [get]
	URL that is configured for this FPGA Manager instance More...
Configuration.ConfigSettings	Config [get]
	Current configuration

Detailed Description

Provides access to the FPGA Manager API

Member Function Documentation

Configure()

void Configure

(

Configuration.ConfigSettings

settings

)

Updates the configuration with which all transport instances are configured from

Parameters

settings

Configuration

Not allowed if the connection has already been opened

Implemented in FpgaManagerApi.

ConfigureAsync()

Task ConfigureAsync

(

Configuration.ConfigSettings

settings

)

Updates the configuration with which all transport instances are configured from asynchronously

Parameters

settings

Configuration

Not allowed if the connection has already been opened

Returns

TAP Task

Implemented in FpgaManagerApi.

CreateMemoryMap()

IMmAccess CreateMemoryMap

(

int

streamNo

)

Creates an interface for memory mapped access

Parameters

streamNo

Stream Number

Returns

Interface for memory mapped access

Not allowed if the connection has already been opened. Stream numbers must be globally unique. Connection must be opened before interface can be accessed.

Implemented in FpgaManagerApi.

CreateMemoryMapAsync()

Task<IMmAccess> CreateMemoryMapAsync

(

int

streamNo

)

Creates an interface for memory mapped access asynchronously

Parameters

streamNo

Stream Number

Returns

TAP task of Interface for memory mapped access

Not allowed if the connection has already been opened. Stream numbers must be globally unique. Connection must be opened before interface can be accessed.

Implemented in FpgaManagerApi.

CreateStream()

IStream CreateStream	(	int	streamNo,
		StreamType	type,
		StreamDirection	direction
	)

Creates an interface for stream access

Parameters

streamNo	Stream Number
type	Stream Type
direction	Direction

Returns

Interface to stream

Not allowed if the connection has already been opened. Stream numbers must be globally unique. Connection must be opened before interface can be accessed.

Implemented in FpgaManagerApi.

CreateStreamAsync()

Task<IStream> CreateStreamAsync	(	int	streamNo,
		StreamType	type,
		StreamDirection	direction
	)

Creates an interface for stream access asynchronously

Parameters

streamNo	Stream Number
type	Stream Type
direction	Direction

Returns

TAP task of Interface to stream

Not allowed if the connection has already been opened. Stream numbers must be globally unique. Connection must be opened before interface can be accessed.

Implemented in FpgaManagerApi.

GetErrorTrace()

string GetErrorTrace

(

)

Error trace of the underlying FPGA Manager transport library

Returns

Error trace string

Implemented in FpgaManagerApi.

Open()

void Open

(

)

Opens the device and all previously created streams

Implemented in FpgaManagerApi.

OpenAsync()

Task OpenAsync

(

)

Opens the device and all previously created streams asynchronously

Returns

TAP Task

Implemented in FpgaManagerApi.

Property Documentation

Details

ApiDetails Details

get

Details of the FPGA Manager libraries

Url

ApiUrl Url

get

URL that is configured for this FPGA Manager instance

---

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

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