BFModule.BFGTLUtils.BFGTLDevice

class BFModule.BFGTLUtils.BFGTLDevice

Bases: pybind11_object

Class used to access and modify GenTL devices.

__init__(self: BFModule.BFGTLUtils.BFGTLDevice) None

Methods

Close(self)

Close the BFGTLDevice.

Open(*args, **kwargs)

Overloaded function.

__init__(self)

boardCount()

Return the number of BitFlow boards installed on the system.

getBoardNumber(self)

Query the board number of the opened CXP register device.

getNode(self, nodeName)

Retrieve a Camera Device node from a given node name.

getNodeNames(self)

Retrieve a list of all available Camera Device node names.

isOpen(self)

Query whether or not a board has been successfully opened.

nodeExists(self, nodeName)

Query whether or not the device contains a node with the given name.

Close(self: BFModule.BFGTLUtils.BFGTLDevice) None

Close the BFGTLDevice.

Open(*args, **kwargs)

Overloaded function.

  1. Open(self: BFModule.BFGTLUtils.BFGTLDevice) -> None

    Show the board select dialog, and open the BFGTLDevice for the selected board. Closes the current Device first, if necessary.

    Return Type

    void

  2. Open(self: BFModule.BFGTLUtils.BFGTLDevice, arg0: int) -> None

    Open a BFGTLDevice for the given board number. Closes the current Device first, if necessary.

    Parameters
    • boardNumber (int): System index number of the board.

    Return Type

    void

static boardCount() int

Return the number of BitFlow boards installed on the system.

getBoardNumber(self: BFModule.BFGTLUtils.BFGTLDevice) int

Query the board number of the opened CXP register device.

Return type

int

Returns

The opened board number.

getNode(self: BFModule.BFGTLUtils.BFGTLDevice, nodeName: str) BFModule.BFGTLUtils.BaseNode

Retrieve a Camera Device node from a given node name.

Parameters

nodeName (str) – Name of the node.

Return type

BaseNode

Returns

Camera Device node from a given node name.

getNodeNames(self: BFModule.BFGTLUtils.BFGTLDevice) List[str]

Retrieve a list of all available Camera Device node names.

Return type

list

Returns

a list of node names.

isOpen(self: BFModule.BFGTLUtils.BFGTLDevice) int

Query whether or not a board has been successfully opened.

Return type

bool

Returns

True if a board is open, false otherwise.

nodeExists(self: BFModule.BFGTLUtils.BFGTLDevice, nodeName: str) int

Query whether or not the device contains a node with the given name.

Parameters

nodeName (str) – Name of the node.

Return type

bool

Returns

True if node of the given name exists, false otherwise.