Spinnaker SDK C++
4.2.0.21
 
 

 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
TransportLayerSystem Class Reference
Spinnaker QuickSpin Classes | Spinnaker QuickSpin Classes » TransportLayerSystem Class

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

#include <TransportLayerSystem.h>

Public Member Functions

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

Public Attributes

GenApi::IString & TLID
 Description: Unique identifier of the GenTL Producer like a GUID.
 
GenApi::IString & TLVendorName
 Description: Name of the GenTL Producer vendor.
 
GenApi::IString & TLModelName
 Description: Name of the GenTL Producer to distinguish different kinds of GenTL Producer implementations from one vendor.
 
GenApi::IString & TLVersion
 Description: Vendor specific version string.
 
GenApi::IString & TLFileName
 Description: Filename including extension of the GenTL Producer.
 
GenApi::IString & TLDisplayName
 Description: User readable name of the GenTL Producer.
 
GenApi::IString & TLPath
 Description: Full path to the GenTL Producer including filename and extension.
 
GenApi::IEnumerationT< TLTypeEnum > & TLType
 Description: Transport layer type of the GenTL Producer implementation.
 
GenApi::IInteger & GenTLVersionMajor
 Description: Major version number of the GenTL specification the GenTL Producer implementation complies with.
 
GenApi::IInteger & GenTLVersionMinor
 Description: Minor version number of the GenTL specification the GenTL Producer implementation complies with.
 
GenApi::IInteger & GenTLSFNCVersionMajor
 Description: Major version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.
 
GenApi::IInteger & GenTLSFNCVersionMinor
 Description: Minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.
 
GenApi::IInteger & GenTLSFNCVersionSubMinor
 Description: Sub minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.
 
GenApi::IInteger & GevVersionMajor
 Description: Major version number of the GigE Vision specification the GenTL Producer implementation complies to.
 
GenApi::IInteger & GevVersionMinor
 Description: Minor version number of the GigE Vision specification the GenTL Producer implementation complies to.
 
GenApi::ICommand & InterfaceUpdateList
 Description: Updates the internal list of the interfaces.
 
GenApi::IInteger & InterfaceSelector
 Description: Selector for the different GenTL Producer interfaces.
 
GenApi::IString & InterfaceID
 Description: GenTL Producer wide unique identifier of the selected interface.
 
GenApi::IString & InterfaceDisplayName
 Description: A user-friendly name of the selected Interface.
 
GenApi::IInteger & GevInterfaceMACAddress
 Description: 48-bit MAC address of the selected interface.
 
GenApi::IInteger & GevInterfaceDefaultIPAddress
 Description: IP address of the first subnet of the selected interface.
 
GenApi::IInteger & GevInterfaceDefaultSubnetMask
 Description: Subnet mask of the first subnet of the selected interface.
 
GenApi::IInteger & GevInterfaceDefaultGateway
 Description: Gateway of the selected interface.
 
GenApi::IBoolean & EnumerateGEVInterfaces
 Description: Enables or disables enumeration of GEV Interfaces.
 
GenApi::IBoolean & EnumerateUSBInterfaces
 Description: Enables or disables enumeration of USB Interfaces.
 
GenApi::IBoolean & EnumerateGen2Cameras
 Description: Enables or disables the enumeration of USB3 and GigE based Generation 2 cameras.
 
GenApi::IBoolean & GEVAutoAssignIPEnable
 Description: GEV cameras on different subnets than their host adapter will be automatically assigned a valid IP.
 

Protected Member Functions

 TransportLayerSystem ()
 

Friends

class System
 
class ISystem
 
class SystemPtrInternal
 

Detailed Description

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

Constructor & Destructor Documentation

◆ TransportLayerSystem() [1/2]

TransportLayerSystem ( GenApi::INodeMap *  nodeMapTLDevice)

◆ ~TransportLayerSystem()

~TransportLayerSystem ( )

◆ TransportLayerSystem() [2/2]

TransportLayerSystem ( )
protected

Friends And Related Symbol Documentation

◆ ISystem

friend class ISystem
friend

◆ System

friend class System
friend

◆ SystemPtrInternal

friend class SystemPtrInternal
friend

Member Data Documentation

◆ EnumerateGen2Cameras

GenApi::IBoolean& EnumerateGen2Cameras

Description: Enables or disables the enumeration of USB3 and GigE based Generation 2 cameras.

This includes the CM3, FL3, GS3, and BFLY families. Visibility: Expert

◆ EnumerateGEVInterfaces

GenApi::IBoolean& EnumerateGEVInterfaces

Description: Enables or disables enumeration of GEV Interfaces.

Visibility: Expert

◆ EnumerateUSBInterfaces

GenApi::IBoolean& EnumerateUSBInterfaces

Description: Enables or disables enumeration of USB Interfaces.

Visibility: Expert

◆ GenTLSFNCVersionMajor

GenApi::IInteger& GenTLSFNCVersionMajor

Description: Major version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.

Visibility: Expert

◆ GenTLSFNCVersionMinor

GenApi::IInteger& GenTLSFNCVersionMinor

Description: Minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.

Visibility: Expert

◆ GenTLSFNCVersionSubMinor

GenApi::IInteger& GenTLSFNCVersionSubMinor

Description: Sub minor version number of the GenTL Standard Features Naming Convention that was used to create the GenTL Producer`s XML.

Visibility: Expert

◆ GenTLVersionMajor

GenApi::IInteger& GenTLVersionMajor

Description: Major version number of the GenTL specification the GenTL Producer implementation complies with.

Visibility: Expert

◆ GenTLVersionMinor

GenApi::IInteger& GenTLVersionMinor

Description: Minor version number of the GenTL specification the GenTL Producer implementation complies with.

Visibility: Expert

◆ GEVAutoAssignIPEnable

GenApi::IBoolean& GEVAutoAssignIPEnable

Description: GEV cameras on different subnets than their host adapter will be automatically assigned a valid IP.

Note: this feature does not work when network adapters are in the IP address range 169.254.0.0/16 (169.254.0.0 through 169.254.255.255). Visibility: Expert

◆ GevInterfaceDefaultGateway

GenApi::IInteger& GevInterfaceDefaultGateway

Description: Gateway of the selected interface.

Visibility: Expert

◆ GevInterfaceDefaultIPAddress

GenApi::IInteger& GevInterfaceDefaultIPAddress

Description: IP address of the first subnet of the selected interface.

Note that for a GenTL Producer implementation supporting GigE Vision this feature is mandatory. Visibility: Expert

◆ GevInterfaceDefaultSubnetMask

GenApi::IInteger& GevInterfaceDefaultSubnetMask

Description: Subnet mask of the first subnet of the selected interface.

Note that for a GenTL Producer implementation supporting GigE Vision this feature is mandatory. Visibility: Expert

◆ GevInterfaceMACAddress

GenApi::IInteger& GevInterfaceMACAddress

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

Note that for a GenTL Producer implementation supporting GigE Vision this feature is mandatory. Visibility: Expert

◆ GevVersionMajor

GenApi::IInteger& GevVersionMajor

Description: Major version number of the GigE Vision specification the GenTL Producer implementation complies to.

Visibility: Expert

◆ GevVersionMinor

GenApi::IInteger& GevVersionMinor

Description: Minor version number of the GigE Vision specification the GenTL Producer implementation complies to.

Visibility: Expert

◆ InterfaceDisplayName

GenApi::IString& InterfaceDisplayName

Description: A user-friendly name of the selected Interface.

Visibility: Beginner

◆ InterfaceID

GenApi::IString& InterfaceID

Description: GenTL Producer wide unique identifier of the selected interface.

Visibility: Beginner

◆ InterfaceSelector

GenApi::IInteger& InterfaceSelector

Description: Selector for the different GenTL Producer interfaces.

This interface list only changes on execution of "InterfaceUpdateList". The selector is 0-based in order to match the index of the C interface. Visibility: Beginner

◆ InterfaceUpdateList

GenApi::ICommand& InterfaceUpdateList

Description: Updates the internal list of the interfaces.

This feature is readable even if the execution cannot be performed immediately. The command then returns and the status can be polled. This function interacts with the TLUpdateInterfaceList function of the GenTL producer. It is up to the GenTL consumer to handle access in case both methods are used. Visibility: Beginner

◆ TLDisplayName

GenApi::IString& TLDisplayName

Description: User readable name of the GenTL Producer.

Visibility: Expert

◆ TLFileName

GenApi::IString& TLFileName

Description: Filename including extension of the GenTL Producer.

Visibility: Expert

◆ TLID

GenApi::IString& TLID

Description: Unique identifier of the GenTL Producer like a GUID.

Visibility: Expert

◆ TLModelName

GenApi::IString& TLModelName

Description: Name of the GenTL Producer to distinguish different kinds of GenTL Producer implementations from one vendor.

Visibility: Beginner

◆ TLPath

GenApi::IString& TLPath

Description: Full path to the GenTL Producer including filename and extension.

Visibility: Expert

◆ TLType

GenApi::IEnumerationT<TLTypeEnum>& TLType

Description: Transport layer type of the GenTL Producer implementation.

Visibility: Expert

◆ TLVendorName

GenApi::IString& TLVendorName

Description: Name of the GenTL Producer vendor.

Visibility: Beginner

◆ TLVersion

GenApi::IString& TLVersion

Description: Vendor specific version string.

Visibility: Beginner

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