Spinnaker C++
4.0.0.116
Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
TransportLayerDevice Class Reference

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

Public Member Functions

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

Public Attributes

GenApi::IStringDeviceID
 Description: Interface-wide unique identifier of this device. More...
 
GenApi::IStringDeviceSerialNumber
 Description: Serial number of the remote device. More...
 
GenApi::IStringDeviceUserID
 Description: User Defined Name. More...
 
GenApi::IStringDeviceVendorName
 Description: Name of the remote device vendor. More...
 
GenApi::IStringDeviceModelName
 Description: Name of the remote device model. More...
 
GenApi::IStringDeviceVersion
 Description: Version of the device. More...
 
GenApi::IIntegerDeviceBootloaderVersion
 Description: Bootloader version for FLIR devices. More...
 
GenApi::IEnumerationT
< DeviceTypeEnum > & 
DeviceType
 Description: Transport layer type of the device. More...
 
GenApi::IStringDeviceDisplayName
 Description: User readable name of the device. More...
 
GenApi::IEnumerationT
< DeviceAccessStatusEnum > & 
DeviceAccessStatus
 Description: Gets the access status the transport layer Producer has on the device. More...
 
GenApi::IIntegerDeviceLinkSpeed
 Description: Indicates the speed of transmission negotiated by the given network interface in Mbps. More...
 
GenApi::IStringDeviceDriverVersion
 Description: Version of the device driver. More...
 
GenApi::IBooleanDeviceIsUpdater
 Description: Indicates whether the device is in updater mode. More...
 
GenApi::IEnumerationT
< GenICamXMLLocationEnum > & 
GenICamXMLLocation
 Description: Sets the location to load GenICam XML. More...
 
GenApi::IStringGenICamXMLPath
 Description: GenICam XML Path. More...
 
GenApi::IEnumerationT
< GUIXMLLocationEnum > & 
GUIXMLLocation
 Description: Sets the location to load GUI XML. More...
 
GenApi::IStringGUIXMLPath
 Description: GUI XML Path. More...
 
GenApi::IEnumerationT
< GevCCPEnum > & 
GevCCP
 Description: Controls the device access privilege of an application. More...
 
GenApi::IIntegerGevDeviceMACAddress
 Description: 48-bit MAC address of the GVCP interface of the selected remote device. More...
 
GenApi::IIntegerGevDeviceIPAddress
 Description: Current IP address of the GVCP interface of the selected remote device. More...
 
GenApi::IIntegerGevDeviceSubnetMask
 Description: Current subnet mask of the GVCP interface of the selected remote device. More...
 
GenApi::IIntegerGevDeviceGateway
 Description: Current gateway IP address of the GVCP interface of the remote device. More...
 
GenApi::IIntegerGevVersionMajor
 Description: Major version of the specification. More...
 
GenApi::IIntegerGevVersionMinor
 Description: Minor version of the specification. More...
 
GenApi::IBooleanGevDeviceModeIsBigEndian
 Description: This represents the endianness of all device's registers (bootstrap registers and manufacturer-specific registers). More...
 
GenApi::IIntegerGevDeviceReadAndWriteTimeout
 Description: The timeout in us for read/write operations to the camera. More...
 
GenApi::IIntegerGevDeviceMaximumRetryCount
 Description: Maximum number of times to retry a read/write operation. More...
 
GenApi::IIntegerGevDevicePort
 Description: Current IP port of the GVCP interface of the selected remote device. More...
 
GenApi::ICommandGevDeviceDiscoverMaximumPacketSize
 Description: Discovers and updates the maximum packet size that can be safely used by the device on the current interface. More...
 
GenApi::IIntegerGevDeviceMaximumPacketSize
 Description: The maximum packet size that can be safely used by the device on the current interface. More...
 
GenApi::IBooleanGevDeviceIsWrongSubnet
 Description: Indicates whether the device is on the wrong subnet. More...
 
GenApi::ICommandGevDeviceAutoForceIP
 Description: Forces the camera to be on the same subnet as its corresponding interface. More...
 
GenApi::ICommandGevDeviceForceIP
 Description: Apply the force IP settings (GevDeviceForceIPAddress, GevDeviceForceSubnetMask and GevDeviceForceGateway) in the Device using ForceIP command. More...
 
GenApi::IIntegerGevDeviceForceIPAddress
 Description: Static IP address to set for the GVCP interface of the remote device. More...
 
GenApi::IIntegerGevDeviceForceSubnetMask
 Description: Static subnet mask to set for GVCP interface of the remote device. More...
 
GenApi::IIntegerGevDeviceForceGateway
 Description: Static gateway IP address to set for the GVCP interface of the remote device. More...
 
GenApi::IBooleanDeviceMulticastMonitorMode
 Description: Controls and indicates if the device is operating in as a Multicast Monitor. More...
 
GenApi::IEnumerationT
< DeviceEndianessMechanismEnum > & 
DeviceEndianessMechanism
 Description: Identifies the endianness handling mode. More...
 
GenApi::ICommandDeviceReset
 Description: Resets and reboots the device. More...
 
GenApi::IStringDeviceInstanceId
 Description: Device Instance Id. More...
 
GenApi::IStringDeviceLocation
 Description: Device Location. More...
 
GenApi::IEnumerationT
< DeviceCurrentSpeedEnum > & 
DeviceCurrentSpeed
 Description: The USB Speed that the device is currently operating at. More...
 
GenApi::IBooleanDeviceU3VProtocol
 Description: Indicates whether the device is communicating in U3V Protocol. More...
 
GenApi::IStringDevicePortId
 Description: Device Port ID. More...
 

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 ( GenApi::INodeMap nodeMapTLDevice)
TransportLayerDevice ( )
protected

Friends And Related Function Documentation

friend class CameraBase
friend
friend class CameraInternal
friend
friend class ICameraBase
friend

Member Data Documentation

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

Visibility: Beginner

GenApi::IInteger& DeviceBootloaderVersion

Description: Bootloader version for FLIR devices.

Visibility: Expert

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

Visibility: Expert

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

GenApi::IString& DeviceDriverVersion

Description: Version of the device driver.

Visibility: Expert

Description: Identifies the endianness handling mode.

Visibility: Expert

GenApi::IString& DeviceID

Description: Interface-wide unique identifier of this device.

Visibility: Expert

GenApi::IString& DeviceInstanceId

Description: Device Instance Id.

Visibility: Invisible

GenApi::IBoolean& DeviceIsUpdater

Description: Indicates whether the device is in updater mode.

Visibility: Expert

GenApi::IInteger& DeviceLinkSpeed

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

Visibility: Expert

GenApi::IString& DeviceLocation

Description: Device Location.

Visibility: Expert

GenApi::IString& DeviceModelName

Description: Name of the remote device model.

Visibility: Beginner

GenApi::IBoolean& DeviceMulticastMonitorMode

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

Visibility: Expert

GenApi::IString& DevicePortId

Description: Device Port ID.

Visibility: Expert

GenApi::ICommand& DeviceReset

Description: Resets and reboots the device.

Visibility: Beginner

GenApi::IString& DeviceSerialNumber

Description: Serial number of the remote device.

Visibility: Expert

Description: Transport layer type of the device.

Visibility: Expert

GenApi::IBoolean& DeviceU3VProtocol

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

Visibility: Expert

GenApi::IString& DeviceUserID

Description: User Defined Name.

Visibility: Expert

GenApi::IString& DeviceVendorName

Description: Name of the remote device vendor.

Visibility: Beginner

GenApi::IString& DeviceVersion

Description: Version of the device.

Visibility: Beginner

Description: Sets the location to load GenICam XML.

Visibility: Beginner

GenApi::IString& GenICamXMLPath

Description: GenICam XML Path.

Visibility: Beginner

Description: Controls the device access privilege of an application.

Visibility: Beginner

GenApi::ICommand& GevDeviceAutoForceIP

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

Visibility: Expert

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

GenApi::IInteger& GevDeviceForceGateway

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

Visibility: Expert

GenApi::ICommand& GevDeviceForceIP

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

Visibility: Expert

GenApi::IInteger& GevDeviceForceIPAddress

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

Visibility: Expert

GenApi::IInteger& GevDeviceForceSubnetMask

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

Visibility: Expert

GenApi::IInteger& GevDeviceGateway

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

Visibility: Expert

GenApi::IInteger& GevDeviceIPAddress

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

Visibility: Expert

GenApi::IBoolean& GevDeviceIsWrongSubnet

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

Visibility: Expert

GenApi::IInteger& GevDeviceMACAddress

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

Visibility: Expert

GenApi::IInteger& GevDeviceMaximumPacketSize

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

Visibility: Expert

GenApi::IInteger& GevDeviceMaximumRetryCount

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

Visibility: Expert

GenApi::IBoolean& GevDeviceModeIsBigEndian

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

Visibility: Expert

GenApi::IInteger& GevDevicePort

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

Visibility: Expert

GenApi::IInteger& GevDeviceReadAndWriteTimeout

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

Visibility: Expert

GenApi::IInteger& GevDeviceSubnetMask

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

Visibility: Expert

GenApi::IInteger& GevVersionMajor

Description: Major version of the specification.

Visibility: Expert

GenApi::IInteger& GevVersionMinor

Description: Minor version of the specification.

Visibility: Expert

Description: Sets the location to load GUI XML.

Visibility: Beginner

GenApi::IString& GUIXMLPath

Description: GUI XML Path.

Visibility: Beginner


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference