Class Spinnaker::TransportLayerInterface¶

ClassList > Spinnaker > TransportLayerInterface

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

#include <TransportLayerInterface.h>

Public Attributes¶

Type	Name
GenApi::ICommand &	ActionCommand
GenApi::IBoolean &	CPUAffinityEnable
GenApi::IEnumerationT< CpuAffinityPrivilegeEnum > &	CpuAffinityPrivilege
GenApi::IEnumerationT< DeviceAccessStatusEnum > &	DeviceAccessStatus
GenApi::IInteger &	DeviceCount
GenApi::IString &	DeviceID
GenApi::IString &	DeviceModelName
GenApi::IInteger &	DeviceSelector
GenApi::IString &	DeviceSerialNumber
GenApi::IString &	DeviceUnlock
GenApi::ICommand &	DeviceUpdateList
GenApi::IString &	DeviceVendorName
GenApi::IEnumerationT< FLIRFilterDriverStatusEnum > &	FLIRFilterDriverStatus
GenApi::IBoolean &	GevActionAckRequired
GenApi::IInteger &	GevActionDeviceKey
GenApi::IInteger &	GevActionGroupKey
GenApi::IInteger &	GevActionGroupMask
GenApi::IInteger &	GevActionTime
GenApi::ICommand &	GevDeviceAutoForceIP
GenApi::ICommand &	GevDeviceDisableDiscovery
GenApi::IBoolean &	GevDeviceDiscoveryEnabled
GenApi::ICommand &	GevDeviceEnableDiscovery
GenApi::IInteger &	GevDeviceForceGateway
GenApi::ICommand &	GevDeviceForceIP
GenApi::IInteger &	GevDeviceForceIPAddress
GenApi::IInteger &	GevDeviceForceSubnetMask
GenApi::IInteger &	GevDeviceGateway
GenApi::IInteger &	GevDeviceIPAddress
GenApi::IInteger &	GevDeviceMACAddress
GenApi::IInteger &	GevDeviceSubnetMask
GenApi::IInteger &	GevInterfaceGateway
GenApi::IInteger &	GevInterfaceGatewaySelector
GenApi::IBoolean &	GevInterfaceIsIPConflict
GenApi::IInteger &	GevInterfaceMACAddress
GenApi::IInteger &	GevInterfaceMTU
GenApi::IInteger &	GevInterfaceReceiveLinkSpeed
GenApi::IInteger &	GevInterfaceSubnetIPAddress
GenApi::IInteger &	GevInterfaceSubnetMask
GenApi::IInteger &	GevInterfaceSubnetSelector
GenApi::IInteger &	GevInterfaceTransmitLinkSpeed
GenApi::IString &	HostAdapterDriverVersion
GenApi::IString &	HostAdapterName
GenApi::IString &	HostAdapterVendor
GenApi::IInteger &	IncompatibleDeviceCount
GenApi::IString &	IncompatibleDeviceID
GenApi::IString &	IncompatibleDeviceModelName
GenApi::IInteger &	IncompatibleDeviceSelector
GenApi::IString &	IncompatibleDeviceVendorName
GenApi::IInteger &	IncompatibleGevDeviceIPAddress
GenApi::IInteger &	IncompatibleGevDeviceMACAddress
GenApi::IInteger &	IncompatibleGevDeviceSubnetMask
GenApi::IString &	InterfaceDisplayName
GenApi::IString &	InterfaceID
GenApi::IEnumerationT< InterfaceTypeEnum > &	InterfaceType
GenApi::IEnumerationT< POEStatusEnum > &	POEStatus
GenApi::IString &	ReceiveSideScalingReservedCores
GenApi::IInteger &	ReceiveSideScalingReservedCoresCount
GenApi::IEnumerationT< TeledyneGigeVisionFilterDriverStatusEnum > &	TeledyneGigeVisionFilterDriverStatus

Public Functions¶

Type	Name
	TransportLayerInterface (GenApi::INodeMap * nodeMapTLDevice)
	~TransportLayerInterface ()

Protected Functions¶

Type	Name
	TransportLayerInterface ()

Public Attributes Documentation¶

variable ActionCommand¶

GenApi::ICommand& Spinnaker::TransportLayerInterface::ActionCommand;

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

variable CPUAffinityEnable¶

GenApi::IBoolean& Spinnaker::TransportLayerInterface::CPUAffinityEnable;

Description: Enable or disable CPU affinity enforcement for this interface. Set to true to start the CPU affinity service, which monitors network bandwidth and enforces process pinning to keep non-reserved workloads off the reserved cores. Set to false to stop enforcement. Visibility: Expert

variable CpuAffinityPrivilege¶

GenApi::IEnumerationT<CpuAffinityPrivilegeEnum>& Spinnaker::TransportLayerInterface::CpuAffinityPrivilege;

Description: Privilege level for CPU affinity operations on this system (0=Unknown, 1=None, 2=Admin) Visibility: Expert

variable DeviceAccessStatus¶

GenApi::IEnumerationT<DeviceAccessStatusEnum>& Spinnaker::TransportLayerInterface::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

variable DeviceCount¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::DeviceCount;

Description: Number of compatible devices detected on current interface. Visibility: Expert

variable DeviceID¶

GenApi::IString& Spinnaker::TransportLayerInterface::DeviceID;

Description: Interface wide unique identifier of the selected device. This value only changes on execution of "DeviceUpdateList". Visibility: Expert

variable DeviceModelName¶

GenApi::IString& Spinnaker::TransportLayerInterface::DeviceModelName;

Description: Name of the device model. This value only changes on execution of "DeviceUpdateList". Visibility: Expert

variable DeviceSelector¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::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

variable DeviceSerialNumber¶

GenApi::IString& Spinnaker::TransportLayerInterface::DeviceSerialNumber;

Description: Serial number of the selected remote device. Visibility: Expert

variable DeviceUnlock¶

GenApi::IString& Spinnaker::TransportLayerInterface::DeviceUnlock;

Description: Unlocks devices for internal use. Visibility: Expert

variable DeviceUpdateList¶

GenApi::ICommand& Spinnaker::TransportLayerInterface::DeviceUpdateList;

Description: Updates the internal device list. Visibility: Expert

variable DeviceVendorName¶

GenApi::IString& Spinnaker::TransportLayerInterface::DeviceVendorName;

Description: Name of the device vendor. This value only changes on execution of "DeviceUpdateList". Visibility: Expert

variable FLIRFilterDriverStatus¶

GenApi::IEnumerationT<FLIRFilterDriverStatusEnum>& Spinnaker::TransportLayerInterface::FLIRFilterDriverStatus;

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

variable GevActionAckRequired¶

GenApi::IBoolean& Spinnaker::TransportLayerInterface::GevActionAckRequired;

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

variable GevActionDeviceKey¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevActionDeviceKey;

Description: Key to authorize the action for the device. Visibility: Expert

variable GevActionGroupKey¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevActionGroupKey;

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

variable GevActionGroupMask¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevActionGroupMask;

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

variable GevActionTime¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevActionTime;

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

variable GevDeviceAutoForceIP¶

GenApi::ICommand& Spinnaker::TransportLayerInterface::GevDeviceAutoForceIP;

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

variable GevDeviceDisableDiscovery¶

GenApi::ICommand& Spinnaker::TransportLayerInterface::GevDeviceDisableDiscovery;

Description: Disables discovery of GEV devices on the interface. Visibility: Expert

variable GevDeviceDiscoveryEnabled¶

GenApi::IBoolean& Spinnaker::TransportLayerInterface::GevDeviceDiscoveryEnabled;

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

variable GevDeviceEnableDiscovery¶

GenApi::ICommand& Spinnaker::TransportLayerInterface::GevDeviceEnableDiscovery;

Description: Enables discovery of GEV devices on the interface. Visibility: Expert

variable GevDeviceForceGateway¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevDeviceForceGateway;

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

variable GevDeviceForceIP¶

GenApi::ICommand& Spinnaker::TransportLayerInterface::GevDeviceForceIP;

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

variable GevDeviceForceIPAddress¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevDeviceForceIPAddress;

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

variable GevDeviceForceSubnetMask¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevDeviceForceSubnetMask;

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

variable GevDeviceGateway¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevDeviceGateway;

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

variable GevDeviceIPAddress¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevDeviceIPAddress;

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

variable GevDeviceMACAddress¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevDeviceMACAddress;

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

variable GevDeviceSubnetMask¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevDeviceSubnetMask;

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

variable GevInterfaceGateway¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceGateway;

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

variable GevInterfaceGatewaySelector¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceGatewaySelector;

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

variable GevInterfaceIsIPConflict¶

GenApi::IBoolean& Spinnaker::TransportLayerInterface::GevInterfaceIsIPConflict;

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

variable GevInterfaceMACAddress¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceMACAddress;

Description: 48-bit MAC address of this interface. Visibility: Expert

variable GevInterfaceMTU¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceMTU;

Description: Maximum transmission unit of this interface. Visibility: Expert

variable GevInterfaceReceiveLinkSpeed¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceReceiveLinkSpeed;

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

variable GevInterfaceSubnetIPAddress¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceSubnetIPAddress;

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

variable GevInterfaceSubnetMask¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceSubnetMask;

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

variable GevInterfaceSubnetSelector¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceSubnetSelector;

Description: Selector for the subnet of this interface. Visibility: Expert

variable GevInterfaceTransmitLinkSpeed¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::GevInterfaceTransmitLinkSpeed;

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

variable HostAdapterDriverVersion¶

GenApi::IString& Spinnaker::TransportLayerInterface::HostAdapterDriverVersion;

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

variable HostAdapterName¶

GenApi::IString& Spinnaker::TransportLayerInterface::HostAdapterName;

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

variable HostAdapterVendor¶

GenApi::IString& Spinnaker::TransportLayerInterface::HostAdapterVendor;

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

variable IncompatibleDeviceCount¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::IncompatibleDeviceCount;

Description: Number of incompatible devices detected on current interface. Visibility: Expert

variable IncompatibleDeviceID¶

GenApi::IString& Spinnaker::TransportLayerInterface::IncompatibleDeviceID;

Description: Interface wide unique identifier of the selected incompatible device. This value only changes on execution of "DeviceUpdateList". Visibility: Expert

variable IncompatibleDeviceModelName¶

GenApi::IString& Spinnaker::TransportLayerInterface::IncompatibleDeviceModelName;

Description: Name of the incompatible device model. This value only changes on execution of "DeviceUpdateList". Visibility: Expert

variable IncompatibleDeviceSelector¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::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

variable IncompatibleDeviceVendorName¶

GenApi::IString& Spinnaker::TransportLayerInterface::IncompatibleDeviceVendorName;

Description: Name of the incompatible device vendor. This value only changes on execution of "DeviceUpdateList". Visibility: Expert

variable IncompatibleGevDeviceIPAddress¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::IncompatibleGevDeviceIPAddress;

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

variable IncompatibleGevDeviceMACAddress¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::IncompatibleGevDeviceMACAddress;

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

variable IncompatibleGevDeviceSubnetMask¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::IncompatibleGevDeviceSubnetMask;

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

variable InterfaceDisplayName¶

GenApi::IString& Spinnaker::TransportLayerInterface::InterfaceDisplayName;

Description: User readable name of the selected interface. Visibility: Expert

variable InterfaceID¶

GenApi::IString& Spinnaker::TransportLayerInterface::InterfaceID;

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

variable InterfaceType¶

GenApi::IEnumerationT<InterfaceTypeEnum>& Spinnaker::TransportLayerInterface::InterfaceType;

Description: Transport layer type of the interface. Visibility: Expert

variable POEStatus¶

GenApi::IEnumerationT<POEStatusEnum>& Spinnaker::TransportLayerInterface::POEStatus;

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

variable ReceiveSideScalingReservedCores¶

GenApi::IString& Spinnaker::TransportLayerInterface::ReceiveSideScalingReservedCores;

Description: Comma-separated list of reserved CPU cores for Receive Side Scaling on this interface Visibility: Expert

variable ReceiveSideScalingReservedCoresCount¶

GenApi::IInteger& Spinnaker::TransportLayerInterface::ReceiveSideScalingReservedCoresCount;

Description: Number of reserved CPU cores for Receive Side Scaling on this interface Visibility: Expert

variable TeledyneGigeVisionFilterDriverStatus¶

GenApi::IEnumerationT<TeledyneGigeVisionFilterDriverStatusEnum>& Spinnaker::TransportLayerInterface::TeledyneGigeVisionFilterDriverStatus;

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

Public Functions Documentation¶

function TransportLayerInterface [1/3]¶

Spinnaker::TransportLayerInterface::TransportLayerInterface (
    GenApi::INodeMap * nodeMapTLDevice
)

function ~TransportLayerInterface¶

Spinnaker::TransportLayerInterface::~TransportLayerInterface ()

Protected Functions Documentation¶

function TransportLayerInterface [2/3]¶

Spinnaker::TransportLayerInterface::TransportLayerInterface ()

The documentation for this class was generated from the following file C:/workspace/include/TransportLayerInterface.h