TransportLayerDevice Class Reference

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

#include <TransportLayerDevice.h>

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

Public Attributes
GenApi::IString &	DeviceID
	Description: Interface-wide unique identifier of this device.
GenApi::IString &	DeviceSerialNumber
	Description: Serial number of the remote device.
GenApi::IString &	DeviceUserID
	Description: User Defined Name.
GenApi::IString &	DeviceVendorName
	Description: Name of the remote device vendor.
GenApi::IString &	DeviceModelName
	Description: Name of the remote device model.
GenApi::IString &	DeviceVersion
	Description: Version of the device.
GenApi::IInteger &	DeviceBootloaderVersion
	Description: Bootloader version for FLIR devices.
GenApi::IEnumerationT< DeviceTypeEnum > &	DeviceType
	Description: Transport layer type of the device.
GenApi::IString &	DeviceDisplayName
	Description: User readable name of the device.
GenApi::IEnumerationT< DeviceAccessStatusEnum > &	DeviceAccessStatus
	Description: Gets the access status the transport layer Producer has on the device.
GenApi::IInteger &	DeviceLinkSpeed
	Description: Indicates the speed of transmission negotiated by the given network interface in Mbps.
GenApi::IString &	DeviceDriverVersion
	Description: Version of the device driver.
GenApi::IBoolean &	DeviceIsUpdater
	Description: Indicates whether the device is in updater mode.
GenApi::IEnumerationT< GenICamXMLLocationEnum > &	GenICamXMLLocation
	Description: Sets the location to load GenICam XML.
GenApi::IString &	GenICamXMLPath
	Description: GenICam XML Path.
GenApi::IEnumerationT< GUIXMLLocationEnum > &	GUIXMLLocation
	Description: Sets the location to load GUI XML.
GenApi::IString &	GUIXMLPath
	Description: GUI XML Path.
GenApi::IEnumerationT< GevCCPEnum > &	GevCCP
	Description: Controls the device access privilege of an application.
GenApi::IInteger &	GevDeviceMACAddress
	Description: 48-bit MAC address of the GVCP interface of the selected remote device.
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 remote device.
GenApi::IInteger &	GevVersionMajor
	Description: Major version of the specification.
GenApi::IInteger &	GevVersionMinor
	Description: Minor version of the specification.
GenApi::IBoolean &	GevDeviceModeIsBigEndian
	Description: This represents the endianness of all device's registers (bootstrap registers and manufacturer-specific registers).
GenApi::IInteger &	GevDeviceReadAndWriteTimeout
	Description: The timeout in us for read/write operations to the camera.
GenApi::IInteger &	GevDeviceMaximumRetryCount
	Description: Maximum number of times to retry a read/write operation.
GenApi::IInteger &	GevDevicePort
	Description: Current IP port of the GVCP interface of the selected remote device.
GenApi::ICommand &	GevDeviceDiscoverMaximumPacketSize
	Description: Discovers and updates the maximum packet size that can be safely used by the device on the current interface.
GenApi::IInteger &	GevDeviceMaximumPacketSize
	Description: The maximum packet size that can be safely used by the device on the current interface.
GenApi::IBoolean &	GevDeviceIsWrongSubnet
	Description: Indicates whether the device is on the wrong subnet.
GenApi::ICommand &	GevDeviceAutoForceIP
	Description: Forces the camera to be on the same subnet as its corresponding interface.
GenApi::ICommand &	GevDeviceForceIP
	Description: Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the Device using ForceIP command.
GenApi::IInteger &	GevDeviceForceIPAddress
	Description: Static IP address to set for the GVCP interface of the remote device.
GenApi::IInteger &	GevDeviceForceSubnetMask
	Description: Static subnet mask to set for GVCP interface of the remote device.
GenApi::IInteger &	GevDeviceForceGateway
	Description: Static gateway IP address to set for the GVCP interface of the remote device.
GenApi::IBoolean &	DeviceMulticastMonitorMode
	Description: Controls and indicates if the device is operating in as a Multicast Monitor.
GenApi::IEnumerationT< DeviceEndianessMechanismEnum > &	DeviceEndianessMechanism
	Description: Identifies the endianness handling mode.
GenApi::ICommand &	DeviceReset
	Description: Resets and reboots the device.
GenApi::IString &	DeviceInstanceId
	Description: Device Instance Id.
GenApi::IString &	DeviceLocation
	Description: Device Location.
GenApi::IEnumerationT< DeviceCurrentSpeedEnum > &	DeviceCurrentSpeed
	Description: The USB Speed that the device is currently operating at.
GenApi::IBoolean &	DeviceU3VProtocol
	Description: Indicates whether the device is communicating in U3V Protocol.
GenApi::IString &	DevicePortId
	Description: Device Port ID.

Protected Member Functions
	TransportLayerDevice ()

Friends
class	CameraBase
class	ICameraBase
class	CameraInternal

Detailed Description

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

Constructor & Destructor Documentation

TransportLayerDevice() [1/2]

TransportLayerDevice

(

GenApi::INodeMap *

nodeMapTLDevice

)

~TransportLayerDevice()

~TransportLayerDevice

(

)

TransportLayerDevice() [2/2]

TransportLayerDevice ( )

protected

Friends And Related Symbol Documentation

CameraBase

friend class CameraBase

friend

CameraInternal

friend class CameraInternal

friend

ICameraBase

friend class ICameraBase

friend

Member Data Documentation

DeviceAccessStatus

GenApi::IEnumerationT<DeviceAccessStatusEnum>& DeviceAccessStatus

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

Visibility: Beginner

DeviceBootloaderVersion

GenApi::IInteger& DeviceBootloaderVersion

Description: Bootloader version for FLIR devices.

Visibility: Expert

DeviceCurrentSpeed

GenApi::IEnumerationT<DeviceCurrentSpeedEnum>& DeviceCurrentSpeed

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

Visibility: Expert

DeviceDisplayName

GenApi::IString& DeviceDisplayName

Description: User readable name of the device.

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

DeviceDriverVersion

GenApi::IString& DeviceDriverVersion

Description: Version of the device driver.

Visibility: Expert

DeviceEndianessMechanism

GenApi::IEnumerationT<DeviceEndianessMechanismEnum>& DeviceEndianessMechanism

Description: Identifies the endianness handling mode.

Visibility: Expert

DeviceID

GenApi::IString& DeviceID

Description: Interface-wide unique identifier of this device.

Visibility: Expert

DeviceInstanceId

GenApi::IString& DeviceInstanceId

Description: Device Instance Id.

Visibility: Invisible

DeviceIsUpdater

GenApi::IBoolean& DeviceIsUpdater

Description: Indicates whether the device is in updater mode.

Visibility: Expert

DeviceLinkSpeed

GenApi::IInteger& DeviceLinkSpeed

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

Visibility: Expert

DeviceLocation

GenApi::IString& DeviceLocation

Description: Device Location.

Visibility: Expert

DeviceModelName

GenApi::IString& DeviceModelName

Description: Name of the remote device model.

Visibility: Beginner

DeviceMulticastMonitorMode

GenApi::IBoolean& DeviceMulticastMonitorMode

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

Visibility: Expert

DevicePortId

GenApi::IString& DevicePortId

Description: Device Port ID.

Visibility: Expert

DeviceReset

GenApi::ICommand& DeviceReset

Description: Resets and reboots the device.

Visibility: Beginner

DeviceSerialNumber

GenApi::IString& DeviceSerialNumber

Description: Serial number of the remote device.

Visibility: Expert

DeviceType

GenApi::IEnumerationT<DeviceTypeEnum>& DeviceType

Description: Transport layer type of the device.

Visibility: Expert

DeviceU3VProtocol

GenApi::IBoolean& DeviceU3VProtocol

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

Visibility: Expert

DeviceUserID

GenApi::IString& DeviceUserID

Description: User Defined Name.

Visibility: Expert

DeviceVendorName

GenApi::IString& DeviceVendorName

Description: Name of the remote device vendor.

Visibility: Beginner

DeviceVersion

GenApi::IString& DeviceVersion

Description: Version of the device.

Visibility: Beginner

GenICamXMLLocation

GenApi::IEnumerationT<GenICamXMLLocationEnum>& GenICamXMLLocation

Description: Sets the location to load GenICam XML.

Visibility: Beginner

GenICamXMLPath

GenApi::IString& GenICamXMLPath

Description: GenICam XML Path.

Visibility: Beginner

GevCCP

GenApi::IEnumerationT<GevCCPEnum>& GevCCP

Description: Controls the device access privilege of an application.

Visibility: Beginner

GevDeviceAutoForceIP

GenApi::ICommand& GevDeviceAutoForceIP

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

Visibility: Expert

GevDeviceDiscoverMaximumPacketSize

GenApi::ICommand& GevDeviceDiscoverMaximumPacketSize

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

Visibility: Expert

GevDeviceForceGateway

GenApi::IInteger& GevDeviceForceGateway

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

Visibility: Expert

GevDeviceForceIP

GenApi::ICommand& GevDeviceForceIP

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

Visibility: Expert

GevDeviceForceIPAddress

GenApi::IInteger& GevDeviceForceIPAddress

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

Visibility: Expert

GevDeviceForceSubnetMask

GenApi::IInteger& GevDeviceForceSubnetMask

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

Visibility: Expert

GevDeviceGateway

GenApi::IInteger& GevDeviceGateway

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

Visibility: Expert

GevDeviceIPAddress

GenApi::IInteger& GevDeviceIPAddress

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

Visibility: Expert

GevDeviceIsWrongSubnet

GenApi::IBoolean& GevDeviceIsWrongSubnet

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

Visibility: Expert

GevDeviceMACAddress

GenApi::IInteger& GevDeviceMACAddress

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

Visibility: Expert

GevDeviceMaximumPacketSize

GenApi::IInteger& GevDeviceMaximumPacketSize

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

Visibility: Expert

GevDeviceMaximumRetryCount

GenApi::IInteger& GevDeviceMaximumRetryCount

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

Visibility: Expert

GevDeviceModeIsBigEndian

GenApi::IBoolean& GevDeviceModeIsBigEndian

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

Visibility: Expert

GevDevicePort

GenApi::IInteger& GevDevicePort

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

Visibility: Expert

GevDeviceReadAndWriteTimeout

GenApi::IInteger& GevDeviceReadAndWriteTimeout

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

Visibility: Expert

GevDeviceSubnetMask

GenApi::IInteger& GevDeviceSubnetMask

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

Visibility: Expert

GevVersionMajor

GenApi::IInteger& GevVersionMajor

Description: Major version of the specification.

Visibility: Expert

GevVersionMinor

GenApi::IInteger& GevVersionMinor

Description: Minor version of the specification.

Visibility: Expert

GUIXMLLocation

GenApi::IEnumerationT<GUIXMLLocationEnum>& GUIXMLLocation

Description: Sets the location to load GUI XML.

Visibility: Beginner

GUIXMLPath

GenApi::IString& GUIXMLPath

Description: GUI XML Path.

Visibility: Beginner

---

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

• include/TransportLayerDevice.h