Pylon Logo Basler Logo
Namespaces | Classes | Enumerations | Functions | Variables
Transport Layer

The Transport Layer Factory or a Transport Layer object are used to enumerate and create pylon Devices. More...

Namespaces

 Pylon::Key
 This namespace contains keys for accessing the properties of pylon info objects.
 

Classes

class  Pylon::DeviceInfoList
 STL std::vector like container for Pylon::CDeviceInfo objects. More...
 
class  Pylon::TlInfoList
 STL std::vector like container for Pylon::CTlInfo objects. More...
 
class  Pylon::AccessModeSet
 Collection of access mode bits. More...
 
class  Pylon::CDeviceInfo
 Holds information about an enumerated device. More...
 
class  Pylon::CTlFactory
 the Transport Layer Factory More...
 
class  Pylon::CTlInfo
 Class used for storing the result of the transport layer enumeration process. More...
 
struct  Pylon::GigEActionCommandResult
 Optional result structure of IGigETransportLayer::IssueActionCommand and IGigETransportLayer::IssueScheduledActionCommand. More...
 
interface  Pylon::IDeviceFactory
 Interface to be implemented by device factories used to create devices. More...
 
interface  Pylon::IInterface
 An interface is used to represent a frame grabber board, a network card, etc. More...
 
interface  Pylon::ITransportLayer
 The interface of Transport Layer objects. More...
 
interface  Pylon::IGigETransportLayer
 Extends the ITransportLayer interface by GigE Vision specific functionality. More...
 

Enumerations

Functions

AccessModeSet & Pylon::AccessModeSet::set (size_t pos)
 Sets the bit at position pos. More...
 
AccessModeSet & Pylon::AccessModeSet::reset ()
 Resets all bits to zero. More...
 
bool Pylon::AccessModeSet::any () const
 Returns whether any of the bits is set (i.e., whether at least one bit in the AccessModeSet is set to one). More...
 
bool Pylon::AccessModeSet::none () const
 Returns whether any of the bits is set (i.e., whether at least one bit in the AccessModeSet is set to one). More...
 
bool Pylon::AccessModeSet::test (size_t pos) const
 Returns whether the bit at position pos is set (i.e., whether it is one). More...
 
unsigned long Pylon::AccessModeSet::to_ulong () const
 Returns an unsigned long with the integer value that has the same bits set as the AccessModeSet. More...
 
AccessModeSet Pylon::operator+ (EDeviceAccessMode lhs, EDeviceAccessMode rhs)
 Creates a set containing lhs and rhs operands. More...
 
AccessModeSet Pylon::operator| (EDeviceAccessMode lhs, EDeviceAccessMode rhs)
 Creates a set containing lhs and rhs operands. More...
 
AccessModeSet Pylon::operator+ (const AccessModeSet &lhs, EDeviceAccessMode rhs)
 Adds the operand rhs to the set lhs. More...
 
AccessModeSet Pylon::operator| (const AccessModeSet &lhs, EDeviceAccessMode rhs)
 Adds the operand rhs to the set lhs. More...
 
bool Pylon::operator== (const AccessModeSet &lhs, const AccessModeSet &rhs)
 Check if the operand rhs is equal to lhs. More...
 
bool Pylon::operator!= (const AccessModeSet &lhs, const AccessModeSet &rhs)
 Check if the operand rhs is not equal to lhs. More...
 
std::ostream & Pylon::operator<< (std::ostream &ostr, const Pylon::AccessModeSet &ams)
 

Variables

const char *const Pylon::Basler1394DeviceClass = "Basler1394"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const Pylon::BaslerGigEDeviceClass = "BaslerGigE"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const Pylon::BaslerCamEmuDeviceClass = "BaslerCamEmu"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const Pylon::BaslerIpCamDeviceClass = "BaslerIPCam"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const Pylon::BaslerCameraLinkDeviceClass = "BaslerCameraLink"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const Pylon::BaslerGenTlDeviceClassPrefix = "BaslerGTC"
 The actual device class string is made up of this prefix + '/' + [TL Vendor] + '/' + [TL Model].
 
const char *const Pylon::BaslerGenTlCxpDeviceClass = "BaslerGTC/Basler/CXP"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const Pylon::BaslerUsbDeviceClass = "BaslerUsb"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 
const char *const Pylon::BaslerBconDeviceClass = "BaslerBcon"
 This device class can be used to create the corresponding Transport Layer object or when creating Devices with the Transport Layer Factory.
 

Detailed Description

The Transport Layer Factory or a Transport Layer object are used to enumerate and create pylon Devices.

An Instant Camera uses a pylon Device internally for operation. The term 'transport layer' is used as an abstraction for a physical interface such as USB, GigE, or Camera Link. You can find more information here:

Enumeration Type Documentation

The available access modes when opening a camera object.

Enumerator
Control 

access the control and status registers

Stream 

access a streaming data channel

Event 

access the event data channel

Exclusive 

exclusive access to the device

Lists possible status codes returned by IGigETransportLayer::IssueActionCommand or IGigETransportLayer::IssueScheduledActionCommand.

Enumerator
GigEActionCommandStatus_Ok 

The device acknowledged the command.

GigEActionCommandStatus_NoRefTime 

The device is not synchronized to a master clock to be used as time reference. Typically used when scheduled action commands cannot be scheduled for a future time since the reference time coming from IEEE 1588 is not locked. The action command has been ignored by the device.

GigEActionCommandStatus_Overflow 

Returned when the scheduled action commands queue is full and the device cannot accept the additional request. The action command has been discarded by the device.

GigEActionCommandStatus_ActionLate 

The requested scheduled action command was requested at a point in time that is in the past. If the time tag of the scheduled action command is in the past (relative to the device timestamp), and if it is a valid action command, then the device will execute this action command immediately and return GigEActionCommandStatus_ActionLate. This status code is used as an indicator to the application requesting the action command that a mis-synchronization might have occurred.

Function Documentation

bool Pylon::AccessModeSet::any ( ) const

Returns whether any of the bits is set (i.e., whether at least one bit in the AccessModeSet is set to one).

Returns
true if any of the bits in the AccessModeSet is set (to one), and false otherwise.
bool Pylon::AccessModeSet::none ( ) const

Returns whether any of the bits is set (i.e., whether at least one bit in the AccessModeSet is set to one).

Returns
true if any of the bits in the AccessModeSet is set (to one), and false otherwise.
bool Pylon::operator!= ( const AccessModeSet lhs,
const AccessModeSet rhs 
)

Check if the operand rhs is not equal to lhs.

Parameters
lhsa set of bits.
rhsthe additional set of bits.
AccessModeSet Pylon::operator+ ( EDeviceAccessMode  lhs,
EDeviceAccessMode  rhs 
)

Creates a set containing lhs and rhs operands.

Parameters
lhsleft operand
rhsright operand
Returns
returns an AccessModeSet containing both operands
AccessModeSet Pylon::operator+ ( const AccessModeSet lhs,
EDeviceAccessMode  rhs 
)

Adds the operand rhs to the set lhs.

Parameters
lhsa set of bits.
rhsthe additional bit
std::ostream& Pylon::operator<< ( std::ostream &  ostr,
const Pylon::AccessModeSet ams 
)
inline

STL operator out

bool Pylon::operator== ( const AccessModeSet lhs,
const AccessModeSet rhs 
)

Check if the operand rhs is equal to lhs.

Parameters
lhsa set of bits.
rhsthe additional set of bits.
AccessModeSet Pylon::operator| ( EDeviceAccessMode  lhs,
EDeviceAccessMode  rhs 
)

Creates a set containing lhs and rhs operands.

Parameters
lhsleft operand
rhsright operand
AccessModeSet Pylon::operator| ( const AccessModeSet lhs,
EDeviceAccessMode  rhs 
)

Adds the operand rhs to the set lhs.

Parameters
lhsa set of bits.
rhsthe additional bit
AccessModeSet& Pylon::AccessModeSet::reset ( )

Resets all bits to zero.

Returns
*this
AccessModeSet& Pylon::AccessModeSet::set ( size_t  pos)

Sets the bit at position pos.

Parameters
posOrder position of the bit whose value is modified. Order positions are counted from the rightmost bit, which is order position 0.
Returns
*this
bool Pylon::AccessModeSet::test ( size_t  pos) const

Returns whether the bit at position pos is set (i.e., whether it is one).

Parameters
posOrder position of the bit whose value is modified. Order positions are counted from the rightmost bit, which is order position 0.
Returns
true if the bit at position pos is set, and false if it is not set.
unsigned long Pylon::AccessModeSet::to_ulong ( ) const

Returns an unsigned long with the integer value that has the same bits set as the AccessModeSet.

Returns
Integer value with the same bit representation as the AccessModeSet object.

pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:56:53)