org.bytedeco.javacpp

Class FlyCapture2.BusManager

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.FlyCapture2.BusManager

Enclosing class:

FlyCapture2

public static class FlyCapture2.BusManager
extends Pointer

The BusManager class provides the functionality for the user to get an PGRGuid for a desired camera or device easily. Once the camera or device token is found, it can then be used to connect to the camera or device through the camera class or device class. In addition, the BusManager class provides the ability to be notified when a camera or device is added or removed or some event occurs on the PC.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FlyCapture2.BusManager() Default constructor.
FlyCapture2.BusManager(int size)
FlyCapture2.BusManager(Pointer p)

Method Summary

Methods

Modifier and Type	Method and Description
static FlyCapture2.Error	DiscoverGigECameras(FlyCapture2.CameraInfo gigECameras, int[] arraySize)
static FlyCapture2.Error	DiscoverGigECameras(FlyCapture2.CameraInfo gigECameras, IntBuffer arraySize)
static FlyCapture2.Error	DiscoverGigECameras(FlyCapture2.CameraInfo gigECameras, IntPointer arraySize) Discover all cameras connected to the network even if they reside on a different subnet.
FlyCapture2.Error	FireBusReset(FlyCapture2.PGRGuid pGuid) Fire a bus reset.
static FlyCapture2.Error	ForceAllIPAddressesAutomatically() Force all cameras on the network to be assigned sequential IP addresses on the same subnet as the netowrk adapters that they are connected to.
static FlyCapture2.Error	ForceAllIPAddressesAutomatically(int serialNumber) Force a camera on the network to be assigned an IP address on the same subnet as the netowrk adapters that it is connected to.
static FlyCapture2.Error	ForceIPAddressToCamera(FlyCapture2.MACAddress macAddress, FlyCapture2.IPAddress ipAddress, FlyCapture2.IPAddress subnetMask, FlyCapture2.IPAddress defaultGateway) Force the camera with the specific MAC address to the specified IP address, subnet mask and default gateway.
FlyCapture2.Error	GetCameraFromIndex(int index, FlyCapture2.PGRGuid pGuid) Gets the PGRGuid for a camera on the PC.
FlyCapture2.Error	GetCameraFromIPAddress(FlyCapture2.IPAddress ipAddress, FlyCapture2.PGRGuid pGuid) Gets the PGRGuid for a camera with the specified IPv4 address.
FlyCapture2.Error	GetCameraFromSerialNumber(int serialNumber, FlyCapture2.PGRGuid pGuid) Gets the PGRGuid for a camera on the PC.
FlyCapture2.Error	GetCameraSerialNumberFromIndex(int index, int[] pSerialNumber)
FlyCapture2.Error	GetCameraSerialNumberFromIndex(int index, IntBuffer pSerialNumber)
FlyCapture2.Error	GetCameraSerialNumberFromIndex(int index, IntPointer pSerialNumber) Gets the serial number of the camera with the specified index.
FlyCapture2.Error	GetDeviceFromIndex(int index, FlyCapture2.PGRGuid pGuid) Gets the PGRGuid for a device.
FlyCapture2.Error	GetInterfaceTypeFromGuid(FlyCapture2.PGRGuid pGuid, int[] pInterfaceType)
FlyCapture2.Error	GetInterfaceTypeFromGuid(FlyCapture2.PGRGuid pGuid, IntBuffer pInterfaceType)
FlyCapture2.Error	GetInterfaceTypeFromGuid(FlyCapture2.PGRGuid pGuid, IntPointer pInterfaceType) Gets the interface type associated with a PGRGuid.
FlyCapture2.Error	GetNumOfCameras(int[] pNumCameras)
FlyCapture2.Error	GetNumOfCameras(IntBuffer pNumCameras)
FlyCapture2.Error	GetNumOfCameras(IntPointer pNumCameras) Gets the number of cameras attached to the PC.
FlyCapture2.Error	GetNumOfDevices(int[] pNumDevices)
FlyCapture2.Error	GetNumOfDevices(IntBuffer pNumDevices)
FlyCapture2.Error	GetNumOfDevices(IntPointer pNumDevices) Gets the number of devices.
FlyCapture2.Error	GetTopology(FlyCapture2.TopologyNode pNode) Gets the topology information for the PC.
FlyCapture2.Error	GetUsbLinkInfo(FlyCapture2.PGRGuid guid, int[] pValue)
FlyCapture2.Error	GetUsbLinkInfo(FlyCapture2.PGRGuid guid, IntBuffer pValue)
FlyCapture2.Error	GetUsbLinkInfo(FlyCapture2.PGRGuid guid, IntPointer pValue) Read usb link info for the port that the specified device is connected to.
FlyCapture2.Error	GetUsbPortStatus(FlyCapture2.PGRGuid guid, int[] pValue)
FlyCapture2.Error	GetUsbPortStatus(FlyCapture2.PGRGuid guid, IntBuffer pValue)
FlyCapture2.Error	GetUsbPortStatus(FlyCapture2.PGRGuid guid, IntPointer pValue) Read usb port status for the port that the specified device is connected to.
FlyCapture2.Error	IsCameraControlable(FlyCapture2.PGRGuid pGuid, BoolPointer pControlable) Query CCP status on camera with corresponding PGRGuid.
FlyCapture2.BusManager	position(int position)
FlyCapture2.Error	ReadPhyRegister(FlyCapture2.PGRGuid guid, int page, int port, int address, int[] pValue)
FlyCapture2.Error	ReadPhyRegister(FlyCapture2.PGRGuid guid, int page, int port, int address, IntBuffer pValue)
FlyCapture2.Error	ReadPhyRegister(FlyCapture2.PGRGuid guid, int page, int port, int address, IntPointer pValue) Read a phy register on the specified device.
FlyCapture2.Error	RegisterCallback(FlyCapture2.BusEventCallback busEventCallback, int callbackType, Pointer pParameter, FlyCapture2.CallbackHandle pCallbackHandle) Register a callback function that will be called when the specified callback event occurs.
FlyCapture2.Error	RescanBus() Force a rescan of the buses.
FlyCapture2.Error	UnregisterCallback(FlyCapture2.CallbackHandle callbackHandle) Unregister a callback function.
FlyCapture2.Error	WritePhyRegister(FlyCapture2.PGRGuid guid, int page, int port, int address, int value) Write a phy register on the specified device.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FlyCapture2.BusManager

public FlyCapture2.BusManager(Pointer p)

FlyCapture2.BusManager

public FlyCapture2.BusManager(int size)

FlyCapture2.BusManager

public FlyCapture2.BusManager()

Default constructor.

Method Detail

position

public FlyCapture2.BusManager position(int position)

Overrides:

position in class Pointer

FireBusReset

public FlyCapture2.Error FireBusReset(FlyCapture2.PGRGuid pGuid)

Fire a bus reset. The actual bus reset is only fired for the specified 1394 bus, but it will effectively cause a global bus reset for the library.

Parameters:

pGuid - PGRGuid of the camera or the device to cause bus reset.

Returns:

An Error indicating the success or failure of the function.

GetNumOfCameras

public FlyCapture2.Error GetNumOfCameras(IntPointer pNumCameras)

Gets the number of cameras attached to the PC.

Parameters:

pNumCameras - The number of cameras attached.

Returns:

An Error indicating the success or failure of the function.

GetNumOfCameras

public FlyCapture2.Error GetNumOfCameras(IntBuffer pNumCameras)

GetNumOfCameras

public FlyCapture2.Error GetNumOfCameras(int[] pNumCameras)

GetCameraFromIPAddress

public FlyCapture2.Error GetCameraFromIPAddress(FlyCapture2.IPAddress ipAddress,
                                       FlyCapture2.PGRGuid pGuid)

Gets the PGRGuid for a camera with the specified IPv4 address.

Parameters:

ipAddress - IP address to get GUID for.

pGuid - Unique PGRGuid for the camera.

Returns:

An Error indicating the success or failure of the function.

GetCameraFromIndex

public FlyCapture2.Error GetCameraFromIndex(int index,
                                   FlyCapture2.PGRGuid pGuid)

Gets the PGRGuid for a camera on the PC. It uniquely identifies the camera specified by the index and is used to identify the camera during a Camera::Connect() call.

Parameters:

index - Zero based index of camera.

pGuid - Unique PGRGuid for the camera.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetCameraFromSerialNumber()

GetCameraFromSerialNumber

public FlyCapture2.Error GetCameraFromSerialNumber(int serialNumber,
                                          FlyCapture2.PGRGuid pGuid)

Gets the PGRGuid for a camera on the PC. It uniquely identifies the camera specified by the serial number and is used to identify the camera during a Camera::Connect() call.

Parameters:

serialNumber - Serial number of camera.

pGuid - Unique PGRGuid for the camera.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetCameraFromIndex()

GetCameraSerialNumberFromIndex

public FlyCapture2.Error GetCameraSerialNumberFromIndex(int index,
                                               IntPointer pSerialNumber)

Gets the serial number of the camera with the specified index.

Parameters:

index - Zero based index of desired camera.

pSerialNumber - Serial number of camera.

Returns:

An Error indicating the success or failure of the function.

GetCameraSerialNumberFromIndex

public FlyCapture2.Error GetCameraSerialNumberFromIndex(int index,
                                               IntBuffer pSerialNumber)

GetCameraSerialNumberFromIndex

public FlyCapture2.Error GetCameraSerialNumberFromIndex(int index,
                                               int[] pSerialNumber)

GetInterfaceTypeFromGuid

public FlyCapture2.Error GetInterfaceTypeFromGuid(FlyCapture2.PGRGuid pGuid,
                                         IntPointer pInterfaceType)

Gets the interface type associated with a PGRGuid. This is useful in situations where there is a need to enumerate all cameras for a particular interface.

Parameters:

pGuid - The PGRGuid to get the interface for.

pInterfaceType - The interface type of the PGRGuid.

Returns:

An Error indicating the success or failure of the function.

GetInterfaceTypeFromGuid

public FlyCapture2.Error GetInterfaceTypeFromGuid(FlyCapture2.PGRGuid pGuid,
                                         IntBuffer pInterfaceType)

GetInterfaceTypeFromGuid

public FlyCapture2.Error GetInterfaceTypeFromGuid(FlyCapture2.PGRGuid pGuid,
                                         int[] pInterfaceType)

GetNumOfDevices

public FlyCapture2.Error GetNumOfDevices(IntPointer pNumDevices)

Gets the number of devices. This may include hubs, host controllers and other hardware devices (including cameras).

Parameters:

pNumDevices - The number of devices found.

Returns:

An Error indicating the success or failure of the function.

GetNumOfDevices

public FlyCapture2.Error GetNumOfDevices(IntBuffer pNumDevices)

GetNumOfDevices

public FlyCapture2.Error GetNumOfDevices(int[] pNumDevices)

GetDeviceFromIndex

public FlyCapture2.Error GetDeviceFromIndex(int index,
                                   FlyCapture2.PGRGuid pGuid)

Gets the PGRGuid for a device. It uniquely identifies the device specified by the index.

Parameters:

index - Zero based index of device.

pGuid - Unique PGRGuid for the device.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetNumOfDevices()

ReadPhyRegister

public FlyCapture2.Error ReadPhyRegister(FlyCapture2.PGRGuid guid,
                                int page,
                                int port,
                                int address,
                                IntPointer pValue)

Read a phy register on the specified device. The full address to be read from is determined by the page, port and address.

Parameters:

guid - PGRGuid of the device to read from.

page - Page to read from.

port - Port to read from.

address - Address to read from.

pValue - Value read from the phy register.

Returns:

An Error indicating the success or failure of the function.

ReadPhyRegister

public FlyCapture2.Error ReadPhyRegister(FlyCapture2.PGRGuid guid,
                                int page,
                                int port,
                                int address,
                                IntBuffer pValue)

ReadPhyRegister

public FlyCapture2.Error ReadPhyRegister(FlyCapture2.PGRGuid guid,
                                int page,
                                int port,
                                int address,
                                int[] pValue)

WritePhyRegister

public FlyCapture2.Error WritePhyRegister(FlyCapture2.PGRGuid guid,
                                 int page,
                                 int port,
                                 int address,
                                 int value)

Write a phy register on the specified device. The full address to be written to is determined by the page, port and address.

Parameters:

guid - PGRGuid of the device to write to.

page - Page to write to.

port - Port to write to.

address - Address to write to.

value - Value to write to phy register.

Returns:

An Error indicating the success or failure of the function.

GetUsbLinkInfo

public FlyCapture2.Error GetUsbLinkInfo(FlyCapture2.PGRGuid guid,
                               IntPointer pValue)

Read usb link info for the port that the specified device is connected to.

Parameters:

guid - PGRGuid of the device to read from.

pValue - Value read from the card register.

Returns:

An Error indicating the success or failure of the function.

GetUsbLinkInfo

public FlyCapture2.Error GetUsbLinkInfo(FlyCapture2.PGRGuid guid,
                               IntBuffer pValue)

GetUsbLinkInfo

public FlyCapture2.Error GetUsbLinkInfo(FlyCapture2.PGRGuid guid,
                               int[] pValue)

GetUsbPortStatus

public FlyCapture2.Error GetUsbPortStatus(FlyCapture2.PGRGuid guid,
                                 IntPointer pValue)

Read usb port status for the port that the specified device is connected to.

Parameters:

guid - PGRGuid of the device to read from.

pValue - Value read from the card register.

Returns:

An Error indicating the success or failure of the function.

GetUsbPortStatus

public FlyCapture2.Error GetUsbPortStatus(FlyCapture2.PGRGuid guid,
                                 IntBuffer pValue)

GetUsbPortStatus

public FlyCapture2.Error GetUsbPortStatus(FlyCapture2.PGRGuid guid,
                                 int[] pValue)

GetTopology

public FlyCapture2.Error GetTopology(FlyCapture2.TopologyNode pNode)

Gets the topology information for the PC.

Parameters:

pNode - TopologyNode object that will contain the topology information.

Returns:

An Error indicating the success or failure of the function.

RegisterCallback

public FlyCapture2.Error RegisterCallback(FlyCapture2.BusEventCallback busEventCallback,
                                 int callbackType,
                                 Pointer pParameter,
                                 FlyCapture2.CallbackHandle pCallbackHandle)

Register a callback function that will be called when the specified callback event occurs.

Parameters:

busEventCallback - Pointer to function that will receive the callback.

callbackType - Type of callback to register for.

pParameter - Callback parameter to be passed to callback.

pCallbackHandle - Unique callback handle used for unregistering callback.

Returns:

An Error indicating the success or failure of the function.

See Also:

UnregisterCallback()

UnregisterCallback

public FlyCapture2.Error UnregisterCallback(FlyCapture2.CallbackHandle callbackHandle)

Unregister a callback function.

Parameters:

callbackHandle - Unique callback handle.

Returns:

An Error indicating the success or failure of the function.

See Also:

RegisterCallback()

RescanBus

public FlyCapture2.Error RescanBus()

Force a rescan of the buses. This does not trigger a bus reset. However, any current connections to a Camera object will be invalidated.

Returns:

An Error indicating the success or failure of the function.

ForceIPAddressToCamera

public static FlyCapture2.Error ForceIPAddressToCamera(FlyCapture2.MACAddress macAddress,
                                       FlyCapture2.IPAddress ipAddress,
                                       FlyCapture2.IPAddress subnetMask,
                                       FlyCapture2.IPAddress defaultGateway)

Force the camera with the specific MAC address to the specified IP address, subnet mask and default gateway. This is useful in situations where a GigE Vision camera is using Persistent IP and the application's subnet is different from the device subnet.

Parameters:

macAddress - MAC address of the camera.

ipAddress - IP address to set on the camera.

subnetMask - Subnet mask to set on the camera.

defaultGateway - Default gateway to set on the camera.

Returns:

An Error indicating the success or failure of the function.

ForceAllIPAddressesAutomatically

public static FlyCapture2.Error ForceAllIPAddressesAutomatically()

Force all cameras on the network to be assigned sequential IP addresses on the same subnet as the netowrk adapters that they are connected to. This is useful in situations where a GigE Vision cameras are using Persistent IP addresses and the application's subnet is different from the devices.

Returns:

An Error indicating the success or failure of the function.

ForceAllIPAddressesAutomatically

public static FlyCapture2.Error ForceAllIPAddressesAutomatically(int serialNumber)

Force a camera on the network to be assigned an IP address on the same subnet as the netowrk adapters that it is connected to. This is useful in situations where a GigE Vision camera is using Persistent IP addresses and the application's subnet is different from the device.

Returns:

An Error indicating the success or failure of the function.

DiscoverGigECameras

public static FlyCapture2.Error DiscoverGigECameras(FlyCapture2.CameraInfo gigECameras,
                                    IntPointer arraySize)

Discover all cameras connected to the network even if they reside on a different subnet. This is useful in situations where a GigE camera is using Persistent IP and the application's subnet is different from the device subnet. After discovering the camera, it is easy to use ForceIPAddressToCamera() to set a different IP configuration.

Parameters:

gigECameras - Pointer to an array of CameraInfo structures.

arraySize - Size of the array. Number of discovered cameras is returned in the same value.

Returns:

An Error indicating the success or failure of the function. If the error is PGRERROR_BUFFER_TOO_SMALL then arraySize will contain the minimum size needed for gigECameras array.

DiscoverGigECameras

public static FlyCapture2.Error DiscoverGigECameras(FlyCapture2.CameraInfo gigECameras,
                                    IntBuffer arraySize)

DiscoverGigECameras

public static FlyCapture2.Error DiscoverGigECameras(FlyCapture2.CameraInfo gigECameras,
                                    int[] arraySize)

IsCameraControlable

public FlyCapture2.Error IsCameraControlable(FlyCapture2.PGRGuid pGuid,
                                    BoolPointer pControlable)

Query CCP status on camera with corresponding PGRGuid. This is useful to determine if a GigE camera can be controlled.

Parameters:

pGuid - PGRGuid of the camera

pControlable - Indicates whether camera is controllable

Returns:

An Error indicating the success or failure of the function.