FpgaManagerApi Class Reference

FPGA Manager API More...

Inheritance diagram for FpgaManagerApi:

Public Member Functions
	FpgaManagerApi (ApiUrl url, Profile profile=Profile.Unspecified)
	Constructs the FPGA Manager IP More...
void	Dispose ()
	Dispose of the FPGA Manager API and close the connection More...
async ValueTask	DisposeAsync ()
	Dispose of the FPGA Manager API and close the connection asynchronously More...
void	Configure (Configuration.ConfigSettings settings)
	Updates the configuration with which all transport instances are configured from More...
async 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...
async 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...
async 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...
async Task	OpenAsync ()
	Opens the device and all previously created streams asynchronously More...

Public Attributes
Configuration.ConfigSettings	Config
	Current configuration

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...
Properties inherited from IFpgaManager
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

FPGA Manager API

Constructor & Destructor Documentation

FpgaManagerApi()

FpgaManagerApi ( ApiUrl  url, Profile  profile = Profile.Unspecified  )

inline

Constructs the FPGA Manager IP

Parameters

url	URL of the FPGA Manager Slave to connect to
profile	Optional configuration profile

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

Implements IFpgaManager.

ConfigureAsync()

async Task ConfigureAsync ( Configuration.ConfigSettings  settings )

inline

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

Implements IFpgaManager.

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.

Implements IFpgaManager.

CreateMemoryMapAsync()

async Task<IMmAccess> CreateMemoryMapAsync ( int  streamNo )

inline

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.

Implements IFpgaManager.

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.

Implements IFpgaManager.

CreateStreamAsync()

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

inline

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.

Implements IFpgaManager.

Dispose()

void Dispose

(

)

Dispose of the FPGA Manager API and close the connection

DisposeAsync()

async ValueTask DisposeAsync

(

)

Dispose of the FPGA Manager API and close the connection asynchronously

GetErrorTrace()

string GetErrorTrace

(

)

Error trace of the underlying FPGA Manager transport library

Returns

Error trace string

Implements IFpgaManager.

Open()

void Open

(

)

Opens the device and all previously created streams

Implements IFpgaManager.

OpenAsync()

async Task OpenAsync ( )

inline

Opens the device and all previously created streams asynchronously

Implements IFpgaManager.

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 class was generated from the following file:

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