ISystem Struct Reference

Interface definition for the FPGA Manager System API More...

#include <FpgaManager_Interfaces.h>

Public Types
typedef types::Version< uint8_t, 2 >	FpgaManagerVersion_t
	FPGA Manager Version number type More...

Public Member Functions
virtual	~ISystem ()=default
	Destructor More...
virtual FpgaManagerVersion_t	GetSwVersion ()=0
	Get the FPGA Manager SW Version number More...
virtual std::string	GetErrorTrace ()=0
	Get the FPGA Manager error trace More...
virtual std::string	GetErrorMessage (int error_code)=0
	Get the error message for a given FPGA Manager error code More...

Detailed Description

Interface definition for the FPGA Manager System API

Member Typedef Documentation

FpgaManagerVersion_t

typedef types::Version<uint8_t, 2> FpgaManagerVersion_t

FPGA Manager Version number type

Constructor & Destructor Documentation

~ISystem()

virtual ~ISystem ( )

virtualdefault

Destructor

Member Function Documentation

GetErrorMessage()

virtual std::string GetErrorMessage ( int  error_code )

pure virtual

Get the error message for a given FPGA Manager error code

Parameters

error_code

Error code to get the message for

Returns

Error message related to the error code

GetErrorTrace()

virtual std::string GetErrorTrace ( )

pure virtual

Get the FPGA Manager error trace

The error trace is useful to find out the root-cause for errors. If any internal errors occur, please send the error trace aquired by this function to the Enclustra support.

Returns

Error trace

GetSwVersion()

virtual FpgaManagerVersion_t GetSwVersion ( )

pure virtual

Get the FPGA Manager SW Version number

Returns

Version number

---

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

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