TransportLayerInterface Class Reference

Part of the QuickSpin API to provide access to camera information without having to first initialize the camera. More...

#include <TransportLayerInterface.h>

Public Member Functions
	TransportLayerInterface (GenApi::INodeMap *nodeMapTLDevice)
	~TransportLayerInterface ()

Public Attributes
GenApi::IString &	InterfaceID
	Description: Transport layer Producer wide unique identifier of the selected interface.
GenApi::IString &	InterfaceDisplayName
	Description: User readable name of the selected interface.
GenApi::IEnumerationT< InterfaceTypeEnum > &	InterfaceType
	Description: Transport layer type of the interface.
GenApi::IInteger &	GevInterfaceGatewaySelector
	Description: Selector for the different gateway entries for this interface.
GenApi::IInteger &	GevInterfaceGateway
	Description: IP address of the selected gateway entry of this interface.
GenApi::IInteger &	GevInterfaceMACAddress
	Description: 48-bit MAC address of this interface.
GenApi::IInteger &	GevInterfaceSubnetSelector
	Description: Selector for the subnet of this interface.
GenApi::IInteger &	GevInterfaceSubnetIPAddress
	Description: IP address of the selected subnet of this interface.
GenApi::IInteger &	GevInterfaceSubnetMask
	Description: Subnet mask of the selected subnet of this interface.
GenApi::IInteger &	GevInterfaceTransmitLinkSpeed
	Description: Transmit link speed of this interface in bits per second.
GenApi::IInteger &	GevInterfaceReceiveLinkSpeed
	Description: Receive link speed of this interface in bits per second.
GenApi::IInteger &	GevInterfaceMTU
	Description: Maximum transmission unit of this interface.
GenApi::IBoolean &	GevInterfaceIsIPConflict
	Description: Indicates whether the adapter has an IP conflict Visibility: Expert.
GenApi::IEnumerationT< POEStatusEnum > &	POEStatus
	Description: Reports and controls the interface's power over Ethernet status.
GenApi::IEnumerationT< FLIRFilterDriverStatusEnum > &	FLIRFilterDriverStatus
	Description: Reports whether FLIR Light Weight Filter Driver is enabled, disabled, or not installed.
GenApi::IEnumerationT< TeledyneGigeVisionFilterDriverStatusEnum > &	TeledyneGigeVisionFilterDriverStatus
	Description: Reports whether Teledyne Gige Vision Filter Driver is enabled, disabled, or not installed.
GenApi::IInteger &	GevActionDeviceKey
	Description: Key to authorize the action for the device.
GenApi::IInteger &	GevActionGroupKey
	Description: Provides the key that the device will use to validate the action on reception of the action protocol message.
GenApi::IInteger &	GevActionGroupMask
	Description: Provides the mask that the device will use to validate the action on reception of the action protocol message.
GenApi::IInteger &	GevActionTime
	Description: Provides the time in nanoseconds when the action is to be executed.
GenApi::IBoolean &	GevActionAckRequired
	Description: Indicates whether an ACK is required from the device after receiving an action command Visibility: Expert.
GenApi::ICommand &	ActionCommand
	Description: Issues an Action Command to attached GEV devices on interface.
GenApi::IString &	DeviceUnlock
	Description: Unlocks devices for internal use.
GenApi::ICommand &	DeviceUpdateList
	Description: Updates the internal device list.
GenApi::IInteger &	DeviceCount
	Description: Number of compatible devices detected on current interface.
GenApi::IInteger &	DeviceSelector
	Description: Selector for the different devices on this interface.
GenApi::IString &	DeviceID
	Description: Interface wide unique identifier of the selected device.
GenApi::IString &	DeviceVendorName
	Description: Name of the device vendor.
GenApi::IString &	DeviceModelName
	Description: Name of the device model.
GenApi::IString &	DeviceSerialNumber
	Description: Serial number of the selected remote device.
GenApi::IEnumerationT< DeviceAccessStatusEnum > &	DeviceAccessStatus
	Description: Gives the device's access status at the moment of the last execution of "DeviceUpdateList".
GenApi::IInteger &	GevDeviceIPAddress
	Description: Current IP address of the GVCP interface of the selected remote device.
GenApi::IInteger &	GevDeviceSubnetMask
	Description: Current subnet mask of the GVCP interface of the selected remote device.
GenApi::IInteger &	GevDeviceGateway
	Description: Current gateway IP address of the GVCP interface of the selected remote device.
GenApi::IInteger &	GevDeviceMACAddress
	Description: 48-bit MAC address of the GVCP interface of the selected remote device.
GenApi::IInteger &	IncompatibleDeviceCount
	Description: Number of incompatible devices detected on current interface.
GenApi::IInteger &	IncompatibleDeviceSelector
	Description: Selector for the devices that are not compatible with Spinnaker on this interface.
GenApi::IString &	IncompatibleDeviceID
	Description: Interface wide unique identifier of the selected incompatible device.
GenApi::IString &	IncompatibleDeviceVendorName
	Description: Name of the incompatible device vendor.
GenApi::IString &	IncompatibleDeviceModelName
	Description: Name of the incompatible device model.
GenApi::IInteger &	IncompatibleGevDeviceIPAddress
	Description: Current IP address of the GVCP interface of the selected remote incompatible device.
GenApi::IInteger &	IncompatibleGevDeviceSubnetMask
	Description: Current subnet mask of the GVCP interface of the selected remote incompatible device.
GenApi::IInteger &	IncompatibleGevDeviceMACAddress
	Description: 48-bit MAC address of the GVCP interface of the selected remote incompatible device.
GenApi::ICommand &	GevDeviceForceIP
	Description: Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the selected remote device using ForceIP command.
GenApi::IInteger &	GevDeviceForceIPAddress
	Description: Static IP address to set for the GVCP interface of the selected remote device.
GenApi::IInteger &	GevDeviceForceSubnetMask
	Description: Static subnet mask to set for GVCP interface of the selected remote device.
GenApi::IInteger &	GevDeviceForceGateway
	Description: Static gateway IP address to set for the GVCP interface of the selected remote device.
GenApi::ICommand &	GevDeviceAutoForceIP
	Description: Automatically forces the selected remote device to an IP Address on the same subnet as the GVCP interface.
GenApi::IBoolean &	GevDeviceDiscoveryEnabled
	Description: Enables or disables discovery of GEV devices on the interface.
GenApi::ICommand &	GevDeviceEnableDiscovery
	Description: Enables discovery of GEV devices on the interface.
GenApi::ICommand &	GevDeviceDisableDiscovery
	Description: Disables discovery of GEV devices on the interface.
GenApi::IString &	HostAdapterName
	Description: User readable name of the interface's host adapter.
GenApi::IString &	HostAdapterVendor
	Description: User readable name of the host adapter's vendor.
GenApi::IString &	HostAdapterDriverVersion
	Description: Driver version of the interface's host adapter.

Protected Member Functions
	TransportLayerInterface ()

Friends
class	Interface
class	IInterface
class	InterfaceInternal

Detailed Description

Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.

Constructor & Destructor Documentation

TransportLayerInterface() [1/2]

TransportLayerInterface

(

GenApi::INodeMap *

nodeMapTLDevice

)

~TransportLayerInterface()

~TransportLayerInterface

(

)

TransportLayerInterface() [2/2]

TransportLayerInterface ( )

protected

Friends And Related Symbol Documentation

IInterface

friend class IInterface

friend

Interface

friend class Interface

friend

InterfaceInternal

friend class InterfaceInternal

friend

Member Data Documentation

ActionCommand

GenApi::ICommand& ActionCommand

Description: Issues an Action Command to attached GEV devices on interface.

Visibility: Expert

DeviceAccessStatus

GenApi::IEnumerationT<DeviceAccessStatusEnum>& DeviceAccessStatus

Description: Gives the device's access status at the moment of the last execution of "DeviceUpdateList".

This value only changes on execution of "DeviceUpdateList". Visibility: Expert

DeviceCount

GenApi::IInteger& DeviceCount

Description: Number of compatible devices detected on current interface.

Visibility: Expert

DeviceID

GenApi::IString& DeviceID

Description: Interface wide unique identifier of the selected device.

This value only changes on execution of "DeviceUpdateList". Visibility: Expert

DeviceModelName

GenApi::IString& DeviceModelName

Description: Name of the device model.

This value only changes on execution of "DeviceUpdateList". Visibility: Expert

DeviceSelector

GenApi::IInteger& DeviceSelector

Description: Selector for the different devices on this interface.

This value only changes on execution of "DeviceUpdateList". The selector is 0-based in order to match the index of the C interface. Visibility: Expert

DeviceSerialNumber

GenApi::IString& DeviceSerialNumber

Description: Serial number of the selected remote device.

Visibility: Expert

DeviceUnlock

GenApi::IString& DeviceUnlock

Description: Unlocks devices for internal use.

Visibility: Expert

DeviceUpdateList

GenApi::ICommand& DeviceUpdateList

Description: Updates the internal device list.

Visibility: Expert

DeviceVendorName

GenApi::IString& DeviceVendorName

Description: Name of the device vendor.

This value only changes on execution of "DeviceUpdateList". Visibility: Expert

FLIRFilterDriverStatus

GenApi::IEnumerationT<FLIRFilterDriverStatusEnum>& FLIRFilterDriverStatus

Description: Reports whether FLIR Light Weight Filter Driver is enabled, disabled, or not installed.

Visibility: Expert

GevActionAckRequired

GenApi::IBoolean& GevActionAckRequired

Description: Indicates whether an ACK is required from the device after receiving an action command Visibility: Expert.

GevActionDeviceKey

GenApi::IInteger& GevActionDeviceKey

Description: Key to authorize the action for the device.

Visibility: Expert

GevActionGroupKey

GenApi::IInteger& GevActionGroupKey

Description: Provides the key that the device will use to validate the action on reception of the action protocol message.

Visibility: Expert

GevActionGroupMask

GenApi::IInteger& GevActionGroupMask

Description: Provides the mask that the device will use to validate the action on reception of the action protocol message.

Visibility: Expert

GevActionTime

GenApi::IInteger& GevActionTime

Description: Provides the time in nanoseconds when the action is to be executed.

Visibility: Expert

GevDeviceAutoForceIP

GenApi::ICommand& GevDeviceAutoForceIP

Description: Automatically forces the selected remote device to an IP Address on the same subnet as the GVCP interface.

Visibility: Expert

GevDeviceDisableDiscovery

GenApi::ICommand& GevDeviceDisableDiscovery

Description: Disables discovery of GEV devices on the interface.

Visibility: Expert

GevDeviceDiscoveryEnabled

GenApi::IBoolean& GevDeviceDiscoveryEnabled

Description: Enables or disables discovery of GEV devices on the interface.

Visibility: Expert

GevDeviceEnableDiscovery

GenApi::ICommand& GevDeviceEnableDiscovery

Description: Enables discovery of GEV devices on the interface.

Visibility: Expert

GevDeviceForceGateway

GenApi::IInteger& GevDeviceForceGateway

Description: Static gateway IP address to set for the GVCP interface of the selected remote device.

Visibility: Expert

GevDeviceForceIP

GenApi::ICommand& GevDeviceForceIP

Description: Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the selected remote device using ForceIP command.

Visibility: Expert

GevDeviceForceIPAddress

GenApi::IInteger& GevDeviceForceIPAddress

Description: Static IP address to set for the GVCP interface of the selected remote device.

Visibility: Expert

GevDeviceForceSubnetMask

GenApi::IInteger& GevDeviceForceSubnetMask

Description: Static subnet mask to set for GVCP interface of the selected remote device.

Visibility: Expert

GevDeviceGateway

GenApi::IInteger& GevDeviceGateway

Description: Current gateway IP address of the GVCP interface of the selected remote device.

Visibility: Expert

GevDeviceIPAddress

GenApi::IInteger& GevDeviceIPAddress

Description: Current IP address of the GVCP interface of the selected remote device.

Visibility: Expert

GevDeviceMACAddress

GenApi::IInteger& GevDeviceMACAddress

Description: 48-bit MAC address of the GVCP interface of the selected remote device.

Visibility: Expert

GevDeviceSubnetMask

GenApi::IInteger& GevDeviceSubnetMask

Description: Current subnet mask of the GVCP interface of the selected remote device.

Visibility: Expert

GevInterfaceGateway

GenApi::IInteger& GevInterfaceGateway

Description: IP address of the selected gateway entry of this interface.

Visibility: Expert

GevInterfaceGatewaySelector

GenApi::IInteger& GevInterfaceGatewaySelector

Description: Selector for the different gateway entries for this interface.

Visibility: Expert

GevInterfaceIsIPConflict

GenApi::IBoolean& GevInterfaceIsIPConflict

Description: Indicates whether the adapter has an IP conflict Visibility: Expert.

GevInterfaceMACAddress

GenApi::IInteger& GevInterfaceMACAddress

Description: 48-bit MAC address of this interface.

Visibility: Expert

GevInterfaceMTU

GenApi::IInteger& GevInterfaceMTU

Description: Maximum transmission unit of this interface.

Visibility: Expert

GevInterfaceReceiveLinkSpeed

GenApi::IInteger& GevInterfaceReceiveLinkSpeed

Description: Receive link speed of this interface in bits per second.

Visibility: Expert

GevInterfaceSubnetIPAddress

GenApi::IInteger& GevInterfaceSubnetIPAddress

Description: IP address of the selected subnet of this interface.

Visibility: Expert

GevInterfaceSubnetMask

GenApi::IInteger& GevInterfaceSubnetMask

Description: Subnet mask of the selected subnet of this interface.

Visibility: Expert

GevInterfaceSubnetSelector

GenApi::IInteger& GevInterfaceSubnetSelector

Description: Selector for the subnet of this interface.

Visibility: Expert

GevInterfaceTransmitLinkSpeed

GenApi::IInteger& GevInterfaceTransmitLinkSpeed

Description: Transmit link speed of this interface in bits per second.

Visibility: Expert

HostAdapterDriverVersion

GenApi::IString& HostAdapterDriverVersion

Description: Driver version of the interface's host adapter.

Visibility: Expert

HostAdapterName

GenApi::IString& HostAdapterName

Description: User readable name of the interface's host adapter.

Visibility: Expert

HostAdapterVendor

GenApi::IString& HostAdapterVendor

Description: User readable name of the host adapter's vendor.

Visibility: Expert

IncompatibleDeviceCount

GenApi::IInteger& IncompatibleDeviceCount

Description: Number of incompatible devices detected on current interface.

Visibility: Expert

IncompatibleDeviceID

GenApi::IString& IncompatibleDeviceID

Description: Interface wide unique identifier of the selected incompatible device.

This value only changes on execution of "DeviceUpdateList". Visibility: Expert

IncompatibleDeviceModelName

GenApi::IString& IncompatibleDeviceModelName

Description: Name of the incompatible device model.

This value only changes on execution of "DeviceUpdateList". Visibility: Expert

IncompatibleDeviceSelector

GenApi::IInteger& IncompatibleDeviceSelector

Description: Selector for the devices that are not compatible with Spinnaker on this interface.

This value only changes on execution of "DeviceUpdateList". The selector is 0-based in order to match the index of the C interface. Visibility: Expert

IncompatibleDeviceVendorName

GenApi::IString& IncompatibleDeviceVendorName

Description: Name of the incompatible device vendor.

This value only changes on execution of "DeviceUpdateList". Visibility: Expert

IncompatibleGevDeviceIPAddress

GenApi::IInteger& IncompatibleGevDeviceIPAddress

Description: Current IP address of the GVCP interface of the selected remote incompatible device.

Visibility: Expert

IncompatibleGevDeviceMACAddress

GenApi::IInteger& IncompatibleGevDeviceMACAddress

Description: 48-bit MAC address of the GVCP interface of the selected remote incompatible device.

Visibility: Expert

IncompatibleGevDeviceSubnetMask

GenApi::IInteger& IncompatibleGevDeviceSubnetMask

Description: Current subnet mask of the GVCP interface of the selected remote incompatible device.

Visibility: Expert

InterfaceDisplayName

GenApi::IString& InterfaceDisplayName

Description: User readable name of the selected interface.

Visibility: Expert

InterfaceID

GenApi::IString& InterfaceID

Description: Transport layer Producer wide unique identifier of the selected interface.

Visibility: Expert

InterfaceType

GenApi::IEnumerationT<InterfaceTypeEnum>& InterfaceType

Description: Transport layer type of the interface.

Visibility: Expert

POEStatus

GenApi::IEnumerationT<POEStatusEnum>& POEStatus

Description: Reports and controls the interface's power over Ethernet status.

Visibility: Expert

TeledyneGigeVisionFilterDriverStatus

GenApi::IEnumerationT<TeledyneGigeVisionFilterDriverStatusEnum>& TeledyneGigeVisionFilterDriverStatus

Description: Reports whether Teledyne Gige Vision Filter Driver is enabled, disabled, or not installed.

Visibility: Expert

---

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

• include/TransportLayerInterface.h