Spinnaker C++
4.0.0.116
Enumerations
TransportLayerDefs Class

Enumerations

enum  StreamTypeEnum {
  StreamType_GigEVision, StreamType_CameraLink, StreamType_CameraLinkHS, StreamType_CoaXPress,
  StreamType_USB3Vision, StreamType_Custom, NUMSTREAMTYPE
}
 The enum definitions for TL Device nodes from the transport layer .xml files. More...
 
enum  StreamModeEnum { StreamMode_Socket, StreamMode_LWF, StreamMode_TeledyneGigeVision, NUMSTREAMMODE }
 
enum  StreamBufferCountModeEnum { StreamBufferCountMode_Manual, NUMSTREAMBUFFERCOUNTMODE }
 
enum  StreamBufferHandlingModeEnum {
  StreamBufferHandlingMode_OldestFirst, StreamBufferHandlingMode_OldestFirstOverwrite, StreamBufferHandlingMode_NewestOnly, StreamBufferHandlingMode_NewestFirst,
  NUMSTREAMBUFFERHANDLINGMODE
}
 
enum  DeviceTypeEnum {
  DeviceType_GigEVision, DeviceType_CameraLink, DeviceType_CameraLinkHS, DeviceType_CoaXPress,
  DeviceType_USB3Vision, DeviceType_Custom, NUMDEVICETYPE
}
 
enum  DeviceAccessStatusEnum {
  DeviceAccessStatus_Unknown, DeviceAccessStatus_ReadWrite, DeviceAccessStatus_ReadOnly, DeviceAccessStatus_NoAccess,
  DeviceAccessStatus_Busy, DeviceAccessStatus_OpenReadWrite, DeviceAccessStatus_OpenReadOnly, NUMDEVICEACCESSSTATUS
}
 
enum  GenICamXMLLocationEnum { GenICamXMLLocation_Device, GenICamXMLLocation_Host, NUMGENICAMXMLLOCATION }
 
enum  GUIXMLLocationEnum { GUIXMLLocation_Device, GUIXMLLocation_Host, NUMGUIXMLLOCATION }
 
enum  GevCCPEnum { GevCCP_EnumEntry_GevCCP_OpenAccess, GevCCP_EnumEntry_GevCCP_ExclusiveAccess, GevCCP_EnumEntry_GevCCP_ControlAccess, NUMGEVCCP }
 
enum  DeviceEndianessMechanismEnum { DeviceEndianessMechanism_Legacy, DeviceEndianessMechanism_Standard, NUMDEVICEENDIANESSMECHANISM }
 
enum  DeviceCurrentSpeedEnum {
  DeviceCurrentSpeed_UnknownSpeed, DeviceCurrentSpeed_LowSpeed, DeviceCurrentSpeed_FullSpeed, DeviceCurrentSpeed_HighSpeed,
  DeviceCurrentSpeed_SuperSpeed, NUMDEVICECURRENTSPEED
}
 
enum  InterfaceTypeEnum {
  InterfaceType_GigEVision, InterfaceType_CameraLink, InterfaceType_CameraLinkHS, InterfaceType_CoaXPress,
  InterfaceType_USB3Vision, InterfaceType_Custom, NUMINTERFACETYPE
}
 
enum  POEStatusEnum { POEStatus_NotSupported, POEStatus_PowerOff, POEStatus_PowerOn, NUMPOESTATUS }
 
enum  FLIRFilterDriverStatusEnum { FLIRFilterDriverStatus_NotSupported, FLIRFilterDriverStatus_Disabled, FLIRFilterDriverStatus_Enabled, NUMFLIRFILTERDRIVERSTATUS }
 
enum  TeledyneGigeVisionFilterDriverStatusEnum { TeledyneGigeVisionFilterDriverStatus_NotSupported, TeledyneGigeVisionFilterDriverStatus_Disabled, TeledyneGigeVisionFilterDriverStatus_Enabled, NUMTELEDYNEGIGEVISIONFILTERDRIVERSTATUS }
 
enum  TLTypeEnum {
  TLType_GigEVision, TLType_CameraLink, TLType_CameraLinkHS, TLType_CoaXPress,
  TLType_USB3Vision, TLType_Mixed, TLType_Custom, NUMTLTYPE
}
 

Detailed Description

Enumeration Type Documentation

enum DeviceAccessStatusEnum

< Gets the access status the transport layer Producer has on the device.

Enumerator
DeviceAccessStatus_Unknown 

Not known to producer.

DeviceAccessStatus_ReadWrite 

Full access

DeviceAccessStatus_ReadOnly 

Read-only access

DeviceAccessStatus_NoAccess 

Not available to connect

DeviceAccessStatus_Busy 

The device is already opened by another entity

DeviceAccessStatus_OpenReadWrite 

Open in Read/Write mode by this GenTL host

DeviceAccessStatus_OpenReadOnly 

Open in Read access mode by this GenTL host

NUMDEVICEACCESSSTATUS 
enum DeviceCurrentSpeedEnum

< The USB Speed that the device is currently operating at.

Enumerator
DeviceCurrentSpeed_UnknownSpeed 

Unknown-Speed.

DeviceCurrentSpeed_LowSpeed 

Low-Speed.

DeviceCurrentSpeed_FullSpeed 

Full-Speed.

DeviceCurrentSpeed_HighSpeed 

High-Speed.

DeviceCurrentSpeed_SuperSpeed 

Super-Speed.

NUMDEVICECURRENTSPEED 
enum DeviceEndianessMechanismEnum

< Identifies the endianness handling mode.

Enumerator
DeviceEndianessMechanism_Legacy 

Handling the device endianness according to GenICam Schema 1.0

DeviceEndianessMechanism_Standard 

Handling the device endianness according to GenICam Schema 1.1 and later

NUMDEVICEENDIANESSMECHANISM 
enum DeviceTypeEnum

< Transport layer type of the device.

Enumerator
DeviceType_GigEVision 

GigE Vision

DeviceType_CameraLink 

Camera Link

DeviceType_CameraLinkHS 

Camera Link High Speed

DeviceType_CoaXPress 

CoaXPress

DeviceType_USB3Vision 

USB3 Vision

DeviceType_Custom 

Custom transport layer

NUMDEVICETYPE 
enum FLIRFilterDriverStatusEnum

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

Enumerator
FLIRFilterDriverStatus_NotSupported 

Not Installed

FLIRFilterDriverStatus_Disabled 

FLIR Light Weight Filter Driver is disabled across all interfaces

FLIRFilterDriverStatus_Enabled 

FLIR Light Weight Filter Driver is enabled

NUMFLIRFILTERDRIVERSTATUS 
enum GenICamXMLLocationEnum

< Sets the location to load GenICam XML.

Enumerator
GenICamXMLLocation_Device 

Load GenICam XML from device

GenICamXMLLocation_Host 

Load GenICam XML from host

NUMGENICAMXMLLOCATION 
enum GevCCPEnum

< Controls the device access privilege of an application.

Enumerator
GevCCP_EnumEntry_GevCCP_OpenAccess 

Open access privilege.

GevCCP_EnumEntry_GevCCP_ExclusiveAccess 

Exclusive access privilege.

GevCCP_EnumEntry_GevCCP_ControlAccess 

Control access privilege.

NUMGEVCCP 
enum GUIXMLLocationEnum

< Sets the location to load GUI XML.

Enumerator
GUIXMLLocation_Device 

Load XML from device

GUIXMLLocation_Host 

Load XML from host

NUMGUIXMLLOCATION 
enum InterfaceTypeEnum

< Transport layer type of the interface.

Enumerator
InterfaceType_GigEVision 

GigE Vision

InterfaceType_CameraLink 

Camera Link

InterfaceType_CameraLinkHS 

Camera Link High Speed

InterfaceType_CoaXPress 

CoaXPress

InterfaceType_USB3Vision 

USB3 Vision

InterfaceType_Custom 

Custom transport layer

NUMINTERFACETYPE 
enum POEStatusEnum

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

Enumerator
POEStatus_NotSupported 

Not Supported

POEStatus_PowerOff 

Power is Off

POEStatus_PowerOn 

Power is On

NUMPOESTATUS 
enum StreamBufferCountModeEnum

< Controls access to setting the number of buffers used for the stream.

Enumerator
StreamBufferCountMode_Manual 

The number of buffers used for the stream is set by the user.

NUMSTREAMBUFFERCOUNTMODE 
enum StreamBufferHandlingModeEnum

< Available buffer handling modes of this data stream:

Enumerator
StreamBufferHandlingMode_OldestFirst 

The application always gets the buffer from the head of the output buffer queue (thus, the oldest available one). If the output buffer queue is empty, the application waits for a newly acquired buffer until the timeout expires.

StreamBufferHandlingMode_OldestFirstOverwrite 

The application always gets the buffer from the head of the output buffer queue (thus, the oldest available one). If the output buffer queue is empty, the application waits for a newly acquired buffer until the timeout expires. If a new buffer arrives it will overwrite the existing buffer from the head of the queue (behaves like a circular buffer).

StreamBufferHandlingMode_NewestOnly 

The application always gets the latest completed buffer (the newest one). If the Output Buffer Queue is empty, the application waits for a newly acquired buffer until the timeout expires. This buffer handling mode is typically used in a live display GUI where it is important that there is no lag between camera and display.

StreamBufferHandlingMode_NewestFirst 

The application always gets the buffer from the tail of the output buffer queue (thus, the newest available one). If the output buffer queue is empty, the application waits for a newly acquired buffer until the timeout expires.

NUMSTREAMBUFFERHANDLINGMODE 
enum StreamModeEnum

< Stream mode of the device.

Enumerator
StreamMode_Socket 

Socket

StreamMode_LWF 

Light Weight Filter Driver

StreamMode_TeledyneGigeVision 

Teledyne Gige Vision Driver

NUMSTREAMMODE 
enum StreamTypeEnum

The enum definitions for TL Device nodes from the transport layer .xml files.

< Stream type of the device.

Enumerator
StreamType_GigEVision 

GigE Vision

StreamType_CameraLink 

Camera Link

StreamType_CameraLinkHS 

Camera Link High Speed

StreamType_CoaXPress 

CoaXPress

StreamType_USB3Vision 

USB3 Vision

StreamType_Custom 

Custom transport layer

NUMSTREAMTYPE 
enum TeledyneGigeVisionFilterDriverStatusEnum

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

Enumerator
TeledyneGigeVisionFilterDriverStatus_NotSupported 

Not Installed

TeledyneGigeVisionFilterDriverStatus_Disabled 

Teledyne Gige Vision Filter Driver is disabled across all interfaces

TeledyneGigeVisionFilterDriverStatus_Enabled 

Teledyne Gige Vision Filter Driver is enabled

NUMTELEDYNEGIGEVISIONFILTERDRIVERSTATUS 
enum TLTypeEnum

< Transport layer type of the GenTL Producer implementation.

Enumerator
TLType_GigEVision 

GigE Vision

TLType_CameraLink 

Camera Link

TLType_CameraLinkHS 

Camera Link High Speed

TLType_CoaXPress 

CoaXPress

TLType_USB3Vision 

USB3 Vision

TLType_Mixed 

Different Interface modules of the GenTL Producer are of different types

TLType_Custom 

Custom transport layer

NUMTLTYPE 
Contact Support Spinnaker® SDK Programmer's Guide and API Reference