Class used to access and modify GenTL devices. More...

Public Member Functions

void Open (uint BoardNumber)

Open a BFGTL Camera Device for the given board number. More...

void OpenSWConnector (uint Switch, uint Connector)

Open a BFGTL Camera Device for the given Board switch and Connector. More...

void Open (uint BoardNumber, IntPtr BoardHandle)

Open a BFGTL Camera Device from the given board number and board handle. The Device must be closed prior to closing the BoardHandle object. This method is often faster than the other Open methods. More...

void Close ()

Close the BFGTL Camera Device. More...

bool GetIsOpen ()

Alternate to the IsOpen property. More...

uint GetBoardNumber ()

Alternate to the BoardNumber property. More...

uint GetBoardSwitch ()

Alternate to the BoardSwitch property. More...

uint GetBoardConnector ()

Alternate to the BoardConnector property. More...

void GetBoardSWConnector (ref uint Switch, ref uint Connector)

Return the board switch and connector

Parameters

Switch	The board switch value of the opened board.
Connector	The board connector of the opened board.

More...

String[] GetNodeNames ()

Retrieve a list of all available Camera Device node names. More...

bool NodeExists (String name)

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

BaseNode GetNode (String name)

Retrieve a Camera Device node from a given node name. More...

Properties
static uint	BoardCount `[get]`
	Returns the number of Camera Link serial ports in this machine that are supported by clallserial.dll. More...

bool	IsOpen `[get]`
	Query whether or not a board has been successfully opened. More...

uint	BoardNumber `[get]`
	Query the board number of the opened CXP register device. If opened by switch and connector, this throws an exception. More...

uint	BoardSwitch `[get]`
	Query the board switch of the opened CXP register device. If opened by board number, this throws an exception. More...

uint	BoardConnector `[get]`
	Query the board connector of the opened CXP register device. If opened by board number, this throws an exception. More...

String[]	NodeNames `[get]`
	Retrieve a list of all available Camera Device node names. More...

Detailed Description

Class used to access and modify GenTL devices.

Member Function Documentation

◆ Close()

void BFGTLUtilities.Device.Close ( )

Close the BFGTL Camera Device.

◆ GetBoardConnector()

uint BFGTLUtilities.Device.GetBoardConnector ( )

Alternate to the BoardConnector property.

Returns: The opened board connector.

See also: BoardSwitch, GetBoardSwitch

BoardConnector GetBoardSWConnector

◆ GetBoardNumber()

uint BFGTLUtilities.Device.GetBoardNumber ( )

Alternate to the BoardNumber property.

Returns: The opened board number

BoardNumber

◆ GetBoardSWConnector()

void BFGTLUtilities.Device.GetBoardSWConnector	(	ref uint	Switch,
		ref uint	Connector
	)

Return the board switch and connector

Parameters

Switch	The board switch value of the opened board.
Connector	The board connector of the opened board.

BoardSwitch GetBoardSwitch BoardConnector GetBoardConnector

◆ GetBoardSwitch()

uint BFGTLUtilities.Device.GetBoardSwitch ( )

Alternate to the BoardSwitch property.

Returns: The opened board switch.

BoardSwitch

See also: BoardConnector, GetBoardConnector

GetBoardSWConnector

◆ GetIsOpen()

bool BFGTLUtilities.Device.GetIsOpen ( )

Alternate to the IsOpen property.

Returns: True if a board is open, false otherwise.

IsOpen

◆ GetNode()

BaseNode BFGTLUtilities.Device.GetNode ( String name )

Retrieve a Camera Device node from a given node name.

Parameters

name

Returns: Handle to the specified node.

Exceptions

ApplicationException Thrown if the device has no node so named.

◆ GetNodeNames()

String [] BFGTLUtilities.Device.GetNodeNames ( )

Retrieve a list of all available Camera Device node names.

◆ NodeExists()

bool BFGTLUtilities.Device.NodeExists ( String name )

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

Returns: Whether or not the device contains a node of the given name, true or false.

◆ Open() [1/2]

void BFGTLUtilities.Device.Open ( uint BoardNumber )

Open a BFGTL Camera Device for the given board number.

Parameters

BoardNumber System index number of the board.

◆ Open() [2/2]

void BFGTLUtilities.Device.Open	(	uint	BoardNumber,
		IntPtr	BoardHandle
	)

Open a BFGTL Camera Device from the given board number and board handle. The Device must be closed prior to closing the BoardHandle object. This method is often faster than the other Open methods.

Parameters

BoardNumber	System index number of the board.
BoardHandle	An existing board handle pointer.

◆ OpenSWConnector()

void BFGTLUtilities.Device.OpenSWConnector	(	uint	Switch,
		uint	Connector
	)

Open a BFGTL Camera Device for the given Board switch and Connector.

Parameters

Switch
Connector

Property Documentation

◆ BoardConnector

uint BFGTLUtilities.Device.BoardConnector

get

Query the board connector of the opened CXP register device. If opened by board number, this throws an exception.

Returns: The opened board connector.

Exceptions

ApplicationException Thrown if this is not open, or if this was not opened using the switch and connector method.

See also: BoardSwitch, GetBoardSwitch

GetBoardConnector GetBoardSWConnector

◆ BoardCount

uint BFGTLUtilities.Device.BoardCount

staticget

Returns the number of Camera Link serial ports in this machine that are supported by clallserial.dll.

◆ BoardNumber

uint BFGTLUtilities.Device.BoardNumber

get

Query the board number of the opened CXP register device. If opened by switch and connector, this throws an exception.

Returns: The opened board number.

Exceptions

ApplicationException Thrown if this is not open, or if this was opened using the switch and connector method.

GetBoardNumber

◆ BoardSwitch

uint BFGTLUtilities.Device.BoardSwitch

get

Query the board switch of the opened CXP register device. If opened by board number, this throws an exception.

Returns: The opened board switch.

Exceptions

ApplicationException Thrown if this is not open, or if this was not opened using the switch and connector method.

GetBoardSwitch

See also: BoardConnector, GetBoardConnector

GetBoardSWConnector

◆ IsOpen

bool BFGTLUtilities.Device.IsOpen

get

Query whether or not a board has been successfully opened.

Returns: True if a board is open, false otherwise.

IsBoardOpen

◆ NodeNames

String [] BFGTLUtilities.Device.NodeNames

get

Retrieve a list of all available Camera Device node names.

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

Generic/Libraries/BFGTLUtilities/BFGTLUtilities.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Close()

◆ GetBoardConnector()

◆ GetBoardNumber()

◆ GetBoardSWConnector()

◆ GetBoardSwitch()

◆ GetIsOpen()

◆ GetNode()

◆ GetNodeNames()

◆ NodeExists()

◆ Open() [1/2]

◆ Open() [2/2]

◆ OpenSWConnector()

Property Documentation

◆ BoardConnector

◆ BoardCount

◆ BoardNumber

◆ BoardSwitch

◆ IsOpen

◆ NodeNames