IFpgaManager Struct Reference

Interface definition of the FPGA Manager API More...

#include <FpgaManager_Interfaces.h>

Inheritance diagram for IFpgaManager:

Public Member Functions
virtual	~IFpgaManager ()=default
	Destructor More...
virtual const types::ApiUrl &	Url () const =0
	Getter for API URL More...
virtual config::ConfigSettings	Config () const =0
	Getter for Configuration More...
virtual types::ApiDetails	Details () const =0
	Details of the FPGA Manager libraries More...
virtual void	Configure (const config::ConfigSettings &settings)=0
	Updates the configuration with which all transport instances are configured from More...
virtual ISystem &	SystemApi ()=0
	Getter for SystemApi interface More...
virtual IMmAccess &	CreateMemoryMap (unsigned stream_idx)=0
	Creates an interface for memory mapped access More...
virtual IStream &	CreateStream (unsigned stream_idx, StreamType type, StreamDirection direction)=0
	Creates an interface for stream access More...
virtual void	Open ()=0
	Opens the FPGA Manager connection and creates all primed memory-maps and streams More...

Detailed Description

Interface definition of the FPGA Manager API

Constructor & Destructor Documentation

~IFpgaManager()

virtual ~IFpgaManager ( )

virtualdefault

Destructor

Member Function Documentation

Config()

virtual config::ConfigSettings Config ( ) const

pure virtual

Getter for Configuration

Returns

ConfigSettings object

Implemented in FpgaManager.

Configure()

virtual void Configure ( const config::ConfigSettings &  settings )

pure virtual

Updates the configuration with which all transport instances are configured from

Not allowed if the connection has already been opened

Parameters

settings

Configuration

Implemented in FpgaManager.

CreateMemoryMap()

virtual IMmAccess& CreateMemoryMap ( unsigned  stream_idx )

pure virtual

Creates an 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.

Parameters

stream_idx

Stream the MM-Handler is attached to (must match FPGA FW implementation)

Returns

Memory mapped access interface

Implemented in FpgaManager.

CreateStream()

virtual IStream& CreateStream ( unsigned  stream_idx, StreamType  type, StreamDirection  direction  )

pure virtual

Creates an interface for stream 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.

Parameters

stream_idx	FPGA Manager stream number to use (must match FPGA FW implementation)
type	Type of the stream
direction	Direction of the stream

Returns

Stream API interface

Implemented in FpgaManager.

Details()

virtual types::ApiDetails Details ( ) const

pure virtual

Details of the FPGA Manager libraries

Returns

ApiDetails object

Implemented in FpgaManager.

Open()

virtual void Open ( )

pure virtual

Opens the FPGA Manager connection and creates all primed memory-maps and streams

Implemented in FpgaManager.

SystemApi()

virtual ISystem& SystemApi ( )

pure virtual

Getter for SystemApi interface

Returns

ISystemApi interface

Implemented in FpgaManager.

Url()

virtual const types::ApiUrl& Url ( ) const

pure virtual

Getter for API URL

Returns

ApiUrl object

Implemented in FpgaManager.

---

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

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