Skip to content

Class Spinnaker::TransportLayerDevice

ClassList > Spinnaker > TransportLayerDevice

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

  • #include <TransportLayerDevice.h>

Public Attributes

Type Name
GenApi::IEnumerationT< DeviceAccessStatusEnum > & DeviceAccessStatus
GenApi::IInteger & DeviceBootloaderVersion
GenApi::IEnumerationT< DeviceCurrentSpeedEnum > & DeviceCurrentSpeed
GenApi::IString & DeviceDisplayName
GenApi::IString & DeviceDriverVersion
GenApi::IEnumerationT< DeviceEndianessMechanismEnum > & DeviceEndianessMechanism
GenApi::IString & DeviceID
GenApi::IString & DeviceInstanceId
GenApi::IBoolean & DeviceIsUpdater
GenApi::IInteger & DeviceLinkSpeed
GenApi::IString & DeviceLocation
GenApi::IString & DeviceModelName
GenApi::IBoolean & DeviceMulticastMonitorMode
GenApi::IString & DevicePortId
GenApi::ICommand & DeviceReset
GenApi::IString & DeviceSerialNumber
GenApi::IEnumerationT< DeviceTypeEnum > & DeviceType
GenApi::IBoolean & DeviceU3VProtocol
GenApi::IString & DeviceUserID
GenApi::IString & DeviceVendorName
GenApi::IString & DeviceVersion
GenApi::IEnumerationT< GUIXMLLocationEnum > & GUIXMLLocation
GenApi::IString & GUIXMLPath
GenApi::IEnumerationT< GenICamXMLLocationEnum > & GenICamXMLLocation
GenApi::IString & GenICamXMLPath
GenApi::IEnumerationT< GevCCPEnum > & GevCCP
GenApi::ICommand & GevDeviceAutoForceIP
GenApi::ICommand & GevDeviceDiscoverMaximumPacketSize
GenApi::IInteger & GevDeviceForceGateway
GenApi::ICommand & GevDeviceForceIP
GenApi::IInteger & GevDeviceForceIPAddress
GenApi::IInteger & GevDeviceForceSubnetMask
GenApi::IInteger & GevDeviceGateway
GenApi::IInteger & GevDeviceIPAddress
GenApi::IBoolean & GevDeviceIsWrongSubnet
GenApi::IInteger & GevDeviceMACAddress
GenApi::IInteger & GevDeviceMaximumPacketSize
GenApi::IInteger & GevDeviceMaximumRetryCount
GenApi::IBoolean & GevDeviceModeIsBigEndian
GenApi::IInteger & GevDevicePort
GenApi::IInteger & GevDeviceReadAndWriteTimeout
GenApi::IInteger & GevDeviceSubnetMask
GenApi::IInteger & GevVersionMajor
GenApi::IInteger & GevVersionMinor
GenApi::IString & StreamID
GenApi::IInteger & StreamSelector

Public Functions

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

Protected Functions

Type Name
TransportLayerDevice ()

Public Attributes Documentation

variable DeviceAccessStatus

GenApi::IEnumerationT<DeviceAccessStatusEnum>& Spinnaker::TransportLayerDevice::DeviceAccessStatus;

Description: Gets the access status the transport layer Producer has on the device. Visibility: Beginner


variable DeviceBootloaderVersion

GenApi::IInteger& Spinnaker::TransportLayerDevice::DeviceBootloaderVersion;

Description: Bootloader version for FLIR devices. Visibility: Expert


variable DeviceCurrentSpeed

GenApi::IEnumerationT<DeviceCurrentSpeedEnum>& Spinnaker::TransportLayerDevice::DeviceCurrentSpeed;

Description: The USB Speed that the device is currently operating at. Visibility: Expert


variable DeviceDisplayName

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceDisplayName;

Description: User readable name of the device. If this is not defined in the device this should be "VENDOR MODEL (ID)". Visibility: Expert


variable DeviceDriverVersion

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceDriverVersion;

Description: Version of the device driver. Visibility: Expert


variable DeviceEndianessMechanism

GenApi::IEnumerationT<DeviceEndianessMechanismEnum>& Spinnaker::TransportLayerDevice::DeviceEndianessMechanism;

Description: Identifies the endianness handling mode. Visibility: Expert


variable DeviceID

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceID;

Description: Interface-wide unique identifier of this device. Visibility: Expert


variable DeviceInstanceId

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceInstanceId;

Description: Device Instance Id. Visibility: Invisible


variable DeviceIsUpdater

GenApi::IBoolean& Spinnaker::TransportLayerDevice::DeviceIsUpdater;

Description: Indicates whether the device is in updater mode. Visibility: Expert


variable DeviceLinkSpeed

GenApi::IInteger& Spinnaker::TransportLayerDevice::DeviceLinkSpeed;

Description: Indicates the speed of transmission negotiated by the given network interface in Mbps. Visibility: Expert


variable DeviceLocation

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceLocation;

Description: Device Location. Visibility: Expert


variable DeviceModelName

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceModelName;

Description: Name of the remote device model. Visibility: Beginner


variable DeviceMulticastMonitorMode

GenApi::IBoolean& Spinnaker::TransportLayerDevice::DeviceMulticastMonitorMode;

Description: Controls and indicates if the device is operating in as a Multicast Monitor. Visibility: Expert


variable DevicePortId

GenApi::IString& Spinnaker::TransportLayerDevice::DevicePortId;

Description: Device Port ID. Visibility: Expert


variable DeviceReset

GenApi::ICommand& Spinnaker::TransportLayerDevice::DeviceReset;

Description: Resets and reboots the device. Visibility: Beginner


variable DeviceSerialNumber

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceSerialNumber;

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


variable DeviceType

GenApi::IEnumerationT<DeviceTypeEnum>& Spinnaker::TransportLayerDevice::DeviceType;

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


variable DeviceU3VProtocol

GenApi::IBoolean& Spinnaker::TransportLayerDevice::DeviceU3VProtocol;

Description: Indicates whether the device is communicating in U3V Protocol. Visibility: Expert


variable DeviceUserID

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceUserID;

Description: User Defined Name. Visibility: Expert


variable DeviceVendorName

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceVendorName;

Description: Name of the remote device vendor. Visibility: Beginner


variable DeviceVersion

GenApi::IString& Spinnaker::TransportLayerDevice::DeviceVersion;

Description: Version of the device. Visibility: Beginner


variable GUIXMLLocation

GenApi::IEnumerationT<GUIXMLLocationEnum>& Spinnaker::TransportLayerDevice::GUIXMLLocation;

Description: Sets the location to load GUI XML. Visibility: Beginner


variable GUIXMLPath

GenApi::IString& Spinnaker::TransportLayerDevice::GUIXMLPath;

Description: GUI XML Path. Visibility: Beginner


variable GenICamXMLLocation

GenApi::IEnumerationT<GenICamXMLLocationEnum>& Spinnaker::TransportLayerDevice::GenICamXMLLocation;

Description: Sets the location to load GenICam XML. Visibility: Beginner


variable GenICamXMLPath

GenApi::IString& Spinnaker::TransportLayerDevice::GenICamXMLPath;

Description: GenICam XML Path. Visibility: Beginner


variable GevCCP

GenApi::IEnumerationT<GevCCPEnum>& Spinnaker::TransportLayerDevice::GevCCP;

Description: Controls the device access privilege of an application. Visibility: Beginner


variable GevDeviceAutoForceIP

GenApi::ICommand& Spinnaker::TransportLayerDevice::GevDeviceAutoForceIP;

Description: Forces the camera to be on the same subnet as its corresponding interface. Visibility: Expert


variable GevDeviceDiscoverMaximumPacketSize

GenApi::ICommand& Spinnaker::TransportLayerDevice::GevDeviceDiscoverMaximumPacketSize;

Description: Discovers and updates the maximum packet size that can be safely used by the device on the current interface. Visibility: Expert


variable GevDeviceForceGateway

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceForceGateway;

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


variable GevDeviceForceIP

GenApi::ICommand& Spinnaker::TransportLayerDevice::GevDeviceForceIP;

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


variable GevDeviceForceIPAddress

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceForceIPAddress;

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


variable GevDeviceForceSubnetMask

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceForceSubnetMask;

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


variable GevDeviceGateway

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceGateway;

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


variable GevDeviceIPAddress

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceIPAddress;

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


variable GevDeviceIsWrongSubnet

GenApi::IBoolean& Spinnaker::TransportLayerDevice::GevDeviceIsWrongSubnet;

Description: Indicates whether the device is on the wrong subnet. Visibility: Expert


variable GevDeviceMACAddress

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceMACAddress;

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


variable GevDeviceMaximumPacketSize

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceMaximumPacketSize;

Description: The maximum packet size that can be safely used by the device on the current interface. Visibility: Expert


variable GevDeviceMaximumRetryCount

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceMaximumRetryCount;

Description: Maximum number of times to retry a read/write operation. Visibility: Expert


variable GevDeviceModeIsBigEndian

GenApi::IBoolean& Spinnaker::TransportLayerDevice::GevDeviceModeIsBigEndian;

Description: This represents the endianness of all device's registers (bootstrap registers and manufacturer-specific registers). Visibility: Expert


variable GevDevicePort

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDevicePort;

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


variable GevDeviceReadAndWriteTimeout

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceReadAndWriteTimeout;

Description: The timeout in us for read/write operations to the camera. Visibility: Expert


variable GevDeviceSubnetMask

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevDeviceSubnetMask;

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


variable GevVersionMajor

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevVersionMajor;

Description: Major version of the specification. Visibility: Expert


variable GevVersionMinor

GenApi::IInteger& Spinnaker::TransportLayerDevice::GevVersionMinor;

Description: Minor version of the specification. Visibility: Expert


variable StreamID

GenApi::IString& Spinnaker::TransportLayerDevice::StreamID;

Description: Device unique ID for the stream. Visibility: Beginner


variable StreamSelector

GenApi::IInteger& Spinnaker::TransportLayerDevice::StreamSelector;

Description: Selector for the different stream channels. This value can be used when fetching the TL Stream Nodemap and does not control which streams are active. Visibility: Beginner


Public Functions Documentation

function TransportLayerDevice [1/3]

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

function ~TransportLayerDevice

Spinnaker::TransportLayerDevice::~TransportLayerDevice () 

Protected Functions Documentation

function TransportLayerDevice [2/3]

Spinnaker::TransportLayerDevice::TransportLayerDevice () 


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