OpalKelly Namespace Reference

Namespace containing public Opal Kelly functions and classes. More...

Classes
class	Buffer
	Fixed size buffer used for passing data to/from script functions. More...
class	DeviceSensors
	Represents the set of read-only sensors available on certain devices. More...
class	DeviceSettings
	Represents the set of settings stored in the given device. More...
class	FPGADataPortAXI
	Provides access to the AXI data transfer interfaces on the FPGA. More...
class	FPGADataPortClassic
	Provides access to the classic FrontPanel data transfer endpoints (wires, triggers, pipes, and registers). More...
class	FrontPanel
	This class encapsulates the functionality of an Opal Kelly FrontPanel-enabled device including FPGA configuration, PLL configuration, and FrontPanel endpoint access. More...
class	FrontPanelAXIFull
	Provides AXI-Full memory-mapped read/write access to the FPGA. More...
class	FrontPanelAXILite
	Provides AXI-Lite register read/write access to the FPGA. More...
class	FrontPanelAXIStream
	Provides AXI-Stream read/write access to the FPGA. More...
class	FrontPanelDevices
	Allows to iterate over and open all devices available in the given realm. More...
class	FrontPanelManager
	Class for managing device connections and disconnections. More...
class	PLL22150
	Container class which holds the appropriate configuration parameters for a Cypress 22150 PLL. More...
class	PLL22393
	Container class which holds the appropriate configuration parameters for a Cypress 22393 PLL. More...
class	ProgressCallback
	Allows to receive progress notifications during FPGA configuration. More...
class	ScriptEngine
	Allows to load scripts and run functions defined in them. More...
class	ScriptValue
	Represents a value passed to a scripting function or returned from it. More...
class	ScriptValues
	A collection of script values. More...

Typedefs
typedef std::unique_ptr< OpalKelly::FrontPanel >	FrontPanelPtr
	Typedef for a smart pointer to OpalKelly::FrontPanel.

Functions
int	GetAPIVersionMajor ()
	Major version of FrontPanel the application was compiled with.
int	GetAPIVersionMinor ()
	Minor version of FrontPanel the application was compiled with.
int	GetAPIVersionMicro ()
	Micro version of FrontPanel the application was compiled with.
const char *	GetAPIVersionString ()
	FrontPanel API version the application was compiled with in string form.
bool	CheckAPIVersion (int major, int minor, int micro)
	Check if FrontPanel version used during run-time is at least the given one.
FrontPanel::ErrorCode	FrontPanelEmulateTestDeviceConnection (const std::string &serial, bool connect)
	Connect/disconnect a device to FrontPanelManager created with a test realm.

Detailed Description

Notice that earlier versions of the library used classes outside of this namespace but with "okC" prefix. These classes still exist for compatibility, but you are encouraged to use the classes in OpalKelly namespace in any new code.

Function Documentation

CheckAPIVersion()

bool OpalKelly::CheckAPIVersion	(	int	major,
		int	minor,
		int	micro )

A call to this function would normally be done inside a check for OK_CHECK_API_VERSION() as otherwise the code guarded by it might not compile when using older library versions, so a typical example of its use would look like the following:

#if OK_CHECK_API_VERSION(5, 2, 0)
    if (OpalKelly::CheckAPIVersion(5, 2, 0)) {
        ... use the new function ...
    } else {
        ... maybe complain about the library being too old ...
    }
#else
    ... maybe fall back to something else ...
#endif

See also

GetAPIVersionMajor(), GetAPIVersionMinor(), GetAPIVersionMicro()

FrontPanelEmulateTestDeviceConnection()

FrontPanel::ErrorCode OpalKelly::FrontPanelEmulateTestDeviceConnection ( const std::string & serial, bool connect )

inline

Connect/disconnect a device to FrontPanelManager created with okREALM_TEST for debug and test purposes. Using the member function is preferred.This function fires OnDeviceAdded/OnDeviceRemoved from the thread where it was called (can be different from the thread where EnterMonitorLoop() is currently running).

Parameters

serial	The serial number of the emulated device.
connect	Whether to call OnDeviceAdded or OnDeviceRemoved.

Returns

NoError - Operation completed successfully.

InvalidParameter - The serial is empty string.

Failed - The device was not added/removed because there is no one test manager or device already exists/removed.

GetAPIVersionMajor()

int OpalKelly::GetAPIVersionMajor

(

)

Major version is the first version component, e.g. for FrontPanel 6.1.0 the major version is 6.

Note: Two versions of this functions are exported to other APIs for compatibility purposes.

# Python: 
import ok
print(ok.GetAPIVersionMajor()) # global function
print(ok.okCFrontPanel.GetAPIVersionMajor()) # member function

See also

OK_API_VERSION_MAJOR, GetAPIVersionMinor(), GetAPIVersionMicro(), CheckAPIVersion()

GetAPIVersionMicro()

int OpalKelly::GetAPIVersionMicro

(

)

Micro version is the third version component, e.g. for FrontPanel 6.1.0 the micro version is 0.

Note: Two versions of this functions are exported to other APIs for compatibility purposes. Using the member function is preferred.

# Python: 
import ok
print(ok.GetAPIVersionMicro()) # global function
print(ok.okCFrontPanel.GetAPIVersionMicro()) # member function

See also

OK_API_VERSION_MICRO, GetAPIVersionMajor(), GetAPIVersionMinor(), CheckAPIVersion()

GetAPIVersionMinor()

int OpalKelly::GetAPIVersionMinor

(

)

Minor version is the second version component, e.g. for FrontPanel 6.1.0 the minor version is 1.

Note: Two versions of this functions are exported to other APIs for compatibility purposes. Using the member function is preferred.

# Python: 
import ok
print(ok.GetAPIVersionMinor()) # global function
print(ok.okCFrontPanel.GetAPIVersionMinor()) # member function

See also

OK_API_VERSION_MINOR, GetAPIVersionMajor(), GetAPIVersionMicro(), CheckAPIVersion()

GetAPIVersionString()

const char * OpalKelly::GetAPIVersionString

(

)

This string is composed of dot-separated major, minor and micro version numbers, e.g. "6.1.0" for FrontPanel 6.1.0.

Note: Two versions of this functions are exported to other APIs for compatibility purposes. Using the member function is preferred.

# Python: 
import ok
print(ok.GetAPIVersionString()) # global function
print(ok.okCFrontPanel.GetAPIVersionString()) # member function

See also

OK_API_VERSION_STRING, GetAPIVersionMajor(), GetAPIVersionMinor(), GetAPIVersionMicro()