Framework Classes¶
class xf::fintech::DeviceManager¶
#include "xf_fintech_device_manager.hpp"
Methods¶
getDeviceList¶
getDeviceList overload (1)¶
static std::vector <Device*> getDeviceList (void)
Returns a vector of ALL available Xilinx devices
getDeviceList overload (2)¶
static std::vector <Device*> getDeviceList (std::string deviceSubString)
Allows a user to get a list of devices whose name contains a specified substring. Passing “u250” would find any devices whose name contained “u250” e.g. “xilinx_u250_xdma_201830_2” This can be useful in a system with different types of cards installed.
Parameters:
deviceSubString | Substring to look for in the device name |
getDeviceList overload (3)¶
static std::vector <Device*> getDeviceList (Device::DeviceType deviceType)
Allows a user to list of devices whose type matches the specifed enumeration This can be useful in a system with different types of cards installed.
Parameters:
deviceType | Device type to look for. |
class xf::fintech::Device¶
#include "xf_fintech_device.hpp"
Methods¶
getCLDevice¶
cl::Device getCLDevice (void)
Retrieves the enclosed OpenCL device object. This allows the user to then invoke any standard OpenCL functions that require a cl::Device object
getDeviceType¶
DeviceType getDeviceType (void)
Retrieves the device type of this object (or DeviceType::UNKNOWN if is not a supported device)
getDeviceTypeString¶
std::string getDeviceTypeString (void)
Converts a string representation of the device type
class xf::fintech::Trace¶
#include "xf_fintech_trace.hpp"
Methods¶
setEnabled¶
static void setEnabled (bool bEnabled)
Allows the user to toggle the output of debug trace.
Parameters:
bEnabled | true to enable trace output, false to disable trace output. |
getEnabled¶
static bool getEnabled (void)
getEnabled true to enable trace output, false to disable trace output.
Returns t
printInfo¶
static int printInfo ( const char* fmt, ... )
Prints a specified INFORMATIONAL string. The output of this will be suppressed if tracing is disabled
printError¶
static int printError ( const char* fmt, ... )
Prints a specified ERROR string. The output from this function will ALWAYS be output even is tracing is disabled.
printCLError¶
static void printCLError (cl_int cl_error_code)
Prints out a textual string representation of the specified OpenCL error code
optionTypeToString¶
static char* optionTypeToString (OptionType optionType)
Prints out a textual string representation of the specified OptionType
setConsoleOutputStream¶
static void setConsoleOutputStream (std::ostream& outputStream)
Sets the primary (i.e. console) output stream to be used. By default this is std::cout
setFileOutputStream¶
static void setFileOutputStream (std::ofstream& outputStream)
Sets the secondary (i.e. file) output stream stream to be used. By default this is not used
enum xf::fintech::Device::DeviceType¶
Recognised Xilinx device types.
// enum values U50 U200 U250 U280 UNKNOWN
enum xf::fintech::OptionType¶
A type representing the option type to be calculated
// enum values Call = 0 Put = 1