Pylon Logo Basler Logo
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
Pylon Namespace Reference

Contains definitions of pylon types. More...

Namespaces

 Key
 This namespace contains keys for accessing the properties of pylon info objects.
 
 TLType
 This namespace contains values for the different transport layer types.
 

Classes

class  AccessException
 Exception thrown to indicate an access error. (i.E. A when trying to set a read-only value) More...
 
class  AccessModeSet
 Collection of access mode bits. More...
 
class  AutoLock
 A scoped lock class to acquire and release a CLock upon creation and destruction. More...
 
class  BadAllocException
 Exception thrown if memory could not be allocated. More...
 
class  CAcquireContinuousConfiguration
 Changes the configuration of the camera to free-running continuous acquisition. More...
 
class  CAcquireSingleFrameConfiguration
 An instant camera configuration for single frame acquisition, Use together with CInstantCamera::GrabOne() only. More...
 
class  CActionTriggerConfiguration
 Changes the configuration of the camera so that it is triggered by the first available action command. More...
 
class  CArrayParameter
 CArrayParameter class used to simplify access to GenApi parameters. More...
 
class  CBaslerUniversalCameraEventHandler
 The camera event handler base class. More...
 
class  CBaslerUniversalConfigurationEventHandler
 The configuration event handler base class. More...
 
class  CBaslerUniversalGrabResultData
 The Universal grab result data. More...
 
class  CBaslerUniversalGrabResultPtr
 The Universal grab result smart pointer. More...
 
class  CBaslerUniversalImageEventHandler
 The image event handler base class. More...
 
class  CBaslerUniversalInstantCamera
 Extends the CInstantCamera by universal parameter interface classes combining all interface types. More...
 
class  CBaslerUniversalInstantCameraArray
 Universal instant camera array. More...
 
struct  CBaslerUniversalInstantCameraTraits
 Lists all the types used by the universal instant camera class. More...
 
class  CBooleanParameter
 CBooleanParameter class used to simplify access to GenApi parameters. More...
 
class  CCameraEventHandler
 The camera event handler base class. More...
 
class  CCameraPixelTypeMapperT
 A camera specific pixeltypemapper (maps device specific pixelformats contained in the generated camera classes to pylon pixeltypes by their name). More...
 
class  CChunkParser
 Low Level API: Base class for chunk parsers returned by camera objects. More...
 
class  CCommandParameter
 CCommandParameter class used to simplify access to GenApi parameters. More...
 
class  CConfigurationEventHandler
 The configuration event handler base class. More...
 
class  CConfigurationHelper
 Helper functions for different camera configuration classes. More...
 
class  CDeviceInfo
 Holds information about an enumerated device. More...
 
class  CDeviceSpecificGrabResultPtr
 Implementation Detail: Header only implementation class for creating device specific grab result ptrs. More...
 
class  CDeviceSpecificInstantCameraArrayT
 Implementation Detail: Header only implementation class for creating device specific Instant Camera Array classes. More...
 
class  CDeviceSpecificInstantCameraT
 Implementation Detail: Header only implementation class for creating device specific Instant Camera classes. More...
 
class  CEnumParameter
 CEnumParameter class used to simplify access to GenApi parameters. More...
 
class  CEventGrabberProxyT
 Low Level API: The event grabber class with parameter access methods. More...
 
class  CFeaturePersistence
 Utility class for saving and restoring camera features to and from a file or string. More...
 
class  CFloatParameter
 CFloatParameter class used to simplify access to GenApi parameters. More...
 
class  CGrabResultData
 Makes the data for one grabbed buffer available. More...
 
class  CGrabResultImageT
 Low Level API: Adapts grab result to Pylon::IImage. More...
 
class  CGrabResultPtr
 A smart pointer holding a reference to grab result data. More...
 
class  CImageDecompressor
 Provides convenient access to cameras that support image compression and helps with decompressing these images. More...
 
class  CImageEventHandler
 The image event handler base class. More...
 
class  CImageFormatConverter
 Creates new images by converting a source image to another format. More...
 
class  CImagePersistence
 Contains static functions supporting loading and saving of images. More...
 
class  CImagePersistenceOptions
 Used to pass options to CImagePersistence methods. More...
 
class  CInfoBase
 Base implementation for PYLON info container. More...
 
class  CInstantCamera
 Provides convenient access to a camera device. More...
 
class  CInstantCameraArray
 Supports grabbing with multiple camera devices. More...
 
class  CInstantInterface
 Provides convenient access to an interface. More...
 
class  CIntegerParameter
 CIntegerParameter class used to simplify access to GenApi parameters. More...
 
class  CInterfaceInfo
 Class used for storing information about an interface object provided by a transport layer. More...
 
class  CLock
 A simple recursive lock class. More...
 
class  CNodeMapProxyT
 Implementation Detail: This class wraps programming interfaces that are generated from GenICam parameter description files to provide native parameter access. More...
 
struct  CompressionInfo_t
 The struct containing information about a grab buffer/result. More...
 
class  CParameter
 CParameter class used to simplify access to GenApi parameters. More...
 
class  CPixelTypeMapper
 A simple pixeltypemapper (maps device specific pixelformats read from device-node map to pylon pixeltypes by their name). More...
 
class  CPylonDeviceProxyT
 Low Level API: The camera class for generic camera devices. More...
 
class  CPylonImage
 Describes an image. More...
 
class  CPylonImageBase
 Provides basic functionality for pylon image classes. More...
 
class  CSoftwareTriggerConfiguration
 Changes the configuration of the camera so that the acquisition of frames is triggered by software trigger. More...
 
class  CStreamGrabberProxyT
 Low Level API: The stream grabber class with parameter access methods. More...
 
class  CStringParameter
 CStringParameter class used to simplify access to GenApi parameters. More...
 
class  CTlFactory
 the Transport Layer Factory More...
 
class  CTlInfo
 Class used for storing the result of the transport layer enumeration process. More...
 
class  CVideoWriter
 Supports writing video files. More...
 
class  DeviceInfoList
 STL std::vector like container for Pylon::CDeviceInfo objects. More...
 
class  DynamicCastException
 Exception thrown to indicate a dynamic cast has failed. Usually this means a value is not of expected type. More...
 
class  EventResult
 Low Level API: An event result. More...
 
class  GenericException
 pylon exception class More...
 
struct  GigEActionCommandResult
 Optional result structure of IGigETransportLayer::IssueActionCommand and IGigETransportLayer::IssueScheduledActionCommand. More...
 
class  GrabResult
 Low Level API: A grab result that combines the used image buffer and status information. More...
 
struct  IBooleanEx
 Extends the GenApi::IBoolean interface with convenience methods. More...
 
class  IBufferFactory
 Usable to create a custom buffer factory when needed. More...
 
interface  IChunkParser
 Low Level API: The interface for chunk parsers analyzing a data stream consisting of chunks. More...
 
struct  ICommandEx
 Extends the GenApi::ICommand interface with convenience methods. More...
 
interface  IDevice
 Low Level API: The interface implemented by all device objects. More...
 
interface  IDeviceFactory
 Interface to be implemented by device factories used to create devices. More...
 
struct  IEnumerationEx
 Extends the GenApi::IEnumeration interface with convenience methods. More...
 
struct  IEnumParameterT
 A template class that is used to create classes derived from CEnumParameter. More...
 
interface  IEventAdapter
 Low Level API: IEventAdapter delivers event messages to ports. More...
 
interface  IEventGrabber
 Low Level API: Interface of an object receiving asynchronous events. More...
 
struct  IFloatEx
 Extends the GenApi::IFloat interface with convenience methods. More...
 
interface  IGigETransportLayer
 Extends the ITransportLayer interface by GigE Vision specific functionality. More...
 
interface  IImage
 Usable to access image properties and image buffer. More...
 
struct  IIntegerEx
 Extends the GenApi::IInteger interface with convenience methods. More...
 
interface  IInterface
 An interface is used to represent a frame grabber board, a network card, etc. More...
 
class  InterfaceInfoList
 STL std::vector like container for Pylon::CInterfaceInfo objects. More...
 
class  InvalidArgumentException
 Exception thrown if an argument passed is invalid. More...
 
interface  IProperties
 interface for a property container More...
 
interface  IPylonDevice
 Low Level API: Interface for camera objects. More...
 
interface  IPylonGigEDevice
 Low Level API: The interface for Basler GigE camera devices. More...
 
struct  IRegisterEx
 Extends the GenApi::IRegister interface with convenience methods. More...
 
interface  IReusableImage
 Extends the IImage interface to be able to reuse the image's resources to represent a different image. More...
 
interface  ISelfReliantChunkParser
 Low Level API: Interface for chunk parsers with an own chunk data node map attached. More...
 
interface  IStreamGrabber
 Low Level API: Interface to an (input) data stream. More...
 
struct  IStringEx
 Extends the GenApi::IString interface with convenience methods. More...
 
interface  ITransportLayer
 The interface of Transport Layer objects. More...
 
struct  IValueEx
 Extends the GenApi::IValue interface with convenience methods. More...
 
class  LogicalErrorException
 Exception thrown to indicate logical errors in program flow. More...
 
class  OutOfRangeException
 Exception thrown if an argument is out of range. More...
 
class  PropertyException
 Exception thrown if a property access fails. More...
 
class  PylonAutoInitTerm
 Helper class to automagically call PylonInitialize and PylonTerminate in constructor and destructor. More...
 
class  RuntimeException
 Exception thrown if a runtime error occurs. More...
 
struct  SBGR8Pixel
 Describes the memory layout of a BGR8 pixel. This pixel is used in Windows bitmaps. More...
 
struct  SBGRA8Pixel
 Describes the memory layout of a BGRA8 pixel. This pixel is used in Windows bitmaps. More...
 
class  SPixelData
 Describes the data of one pixel. More...
 
struct  SRGB16Pixel
 Describes the memory layout of a RGB16 pixel. More...
 
struct  SRGB8Pixel
 Describes the memory layout of a RGB8 pixel. More...
 
struct  SYUV422_UYVY
 Describes the memory layout of a YUV422_UYVY pixel with information about brightness and chroma for two pixels. More...
 
struct  SYUV422_YUYV
 Describes the memory layout of a YUV422_YUYV pixel with information about brightness and chroma for two pixels. More...
 
class  TimeoutException
 Exception thrown when a timeout has elapsed. More...
 
class  TlInfoList
 STL std::vector like container for Pylon::CTlInfo objects. More...
 
class  TList
 STL std::vector like container class. More...
 
class  VersionInfo
 Holds a four-part version number consisting of major.minor.subminor.build. More...
 
class  WaitObject
 A platform independent wait object. More...
 
class  WaitObjectEx
 A wait object that the user may signal. More...
 
class  WaitObjects
 A set of wait objects. More...
 

Typedefs

typedef DeviceInfoList DeviceInfoList_t
 STL std::vector like container for Pylon::CDeviceInfo objects. More...
 
typedef TlInfoList TlInfoList_t
 STL std::vector like container for Pylon::CTlInfo objects. More...
 
typedef InterfaceInfoList InterfaceInfoList_t
 STL std::vector like container for Pylon::CInterfaceInfo objects. More...
 
typedef Pylon::Callback1< IPylonDevice * > DeviceCallback
 callback type with a IPylonDevice as parameter
 
typedef void * DeviceCallbackHandle
 opaque device callback object
 
typedef CGrabResultImageT< GrabResultCGrabResultImage
 Low Level API: Adapts a copy of a grab result to pylon image. More...
 
typedef GenICam::gcstring String_t
 Pylon's string definition.
 
typedef GenICam::gcstring_vector StringList_t
 Pylon's string list definition.
 
typedef void * StreamBufferHandle
 This opaque type represents a registered buffer.
 
typedef pthread_t THREADHANDLE
 Typedef for a pthreads thread handle.
 

Enumerations

Functions

template<class T >
TList< T >::iterator operator+ (intptr_t iInc, const typename TList< T >::iterator &iter)
 Gets the sum of the given iInc and the given iter. More...
 
template<class Function >
DeviceCallbackHandle RegisterRemovalCallback (IPylonDevice *pDevice, Function f)
 Low Level API: Register a C-function as a removal callback. More...
 
template<class Client , class Member >
DeviceCallbackHandle RegisterRemovalCallback (IPylonDevice *pDevice, Client &c, Member m)
 Low Level API: Register a C++-member function as removal callback. More...
 
AccessModeSet operator+ (EDeviceAccessMode lhs, EDeviceAccessMode rhs)
 Creates a set containing lhs and rhs operands. More...
 
AccessModeSet operator| (EDeviceAccessMode lhs, EDeviceAccessMode rhs)
 Creates a set containing lhs and rhs operands. More...
 
AccessModeSet operator+ (const AccessModeSet &lhs, EDeviceAccessMode rhs)
 Adds the operand rhs to the set lhs. More...
 
AccessModeSet operator| (const AccessModeSet &lhs, EDeviceAccessMode rhs)
 Adds the operand rhs to the set lhs. More...
 
bool operator== (const AccessModeSet &lhs, const AccessModeSet &rhs)
 Check if the operand rhs is equal to lhs. More...
 
bool operator!= (const AccessModeSet &lhs, const AccessModeSet &rhs)
 Check if the operand rhs is not equal to lhs. More...
 
std::ostream & operator<< (std::ostream &ostr, const Pylon::AccessModeSet &ams)
 
bool IsMonoPacked (EPixelType pixelType)
 Returns true if the pixel type is Mono and the pixel values are not byte aligned.
 
bool IsBayerPacked (EPixelType pixelType)
 Returns true if the pixel type is Bayer and the pixel values are not byte aligned.
 
bool IsRGBPacked (EPixelType pixelType)
 Returns true if the pixel type is RGB and the pixel values are not byte aligned.
 
bool IsBGRPacked (EPixelType pixelType)
 Returns true if the pixel type is BGR and the pixel values are not byte aligned.
 
bool IsPacked (EPixelType pixelType)
 Returns true if the pixels of the given pixel type are not byte aligned.
 
bool IsPackedInLsbFormat (EPixelType pixelType)
 
uint32_t PlaneCount (EPixelType pixelType)
 Returns number of planes in the image composed of the pixel type.
 
EPixelType GetPlanePixelType (EPixelType pixelType)
 Returns the pixel type of a plane.
 
bool IsPlanar (EPixelType pixelType)
 Returns true if images of the pixel type are divided into multiple planes.
 
EPixelColorFilter GetPixelColorFilter (EPixelType pixelType)
 Returns the Bayer color filter type.
 
uint32_t BitPerPixel (EPixelType pixelType)
 Returns the bits needed to store a pixel. More...
 
uint32_t SamplesPerPixel (EPixelType pixelType)
 Returns the number of measured values per pixel. More...
 
bool IsYUV (EPixelType pixelType)
 Returns true when the pixel type represents a YUV format.
 
bool IsRGBA (EPixelType pixelType)
 Returns true when the pixel type represents an RGBA format.
 
bool IsRGB (EPixelType pixelType)
 Returns true when the pixel type represents an RGB or RGBA format.
 
bool IsBGRA (EPixelType pixelType)
 Returns true when the pixel type represents a BGRA format.
 
bool IsBGR (EPixelType pixelType)
 Returns true when the pixel type represents a BGR or BGRA format.
 
bool IsBayer (EPixelType pixelType)
 Returns true when the pixel type represents a Bayer format.
 
bool IsMono (EPixelType pixelType)
 Returns true when a given pixel is monochrome, e.g. PixelType_Mono8 or PixelType_BayerGR8.
 
bool IsMonoImage (EPixelType pixelType)
 Returns true when an image using the given pixel type is monochrome, e.g. PixelType_Mono8.
 
bool IsColorImage (EPixelType pixelType)
 Returns true when an image using the given pixel type is a color image (RGB/BGR/RGBA/BGRA/ etc or Bayer.
 
bool HasAlpha (EPixelType pixelType)
 Returns true when an the image using the given pixel type has an alpha channel.
 
uint32_t GetPixelIncrementX (EPixelType pixelType)
 Returns the minimum step size expressed in pixels for extracting an AOI.
 
uint32_t GetPixelIncrementY (EPixelType pixelType)
 Returns the minimum step size expressed in pixels for extracting an AOI.
 
uint32_t BitDepth (EPixelType pixelType)
 Returns the bit depth of a value of the pixel in bits. More...
 
bool ComputeStride (size_t &strideBytes, EPixelType pixelType, uint32_t width, size_t paddingX=0)
 Computes the stride in byte. More...
 
size_t ComputePaddingX (size_t strideBytes, EPixelType pixelType, uint32_t width)
 Computes the padding value from row stride in byte. More...
 
size_t ComputeBufferSize (EPixelType pixelType, uint32_t width, uint32_t height, size_t paddingX=0)
 Computes the buffer size in byte. More...
 
bool GetPixelTypesForUnpacking (EPixelType pixelTypeSource, EPixelType &pixelTypeToImpose, EPixelType &pixelTypeTarget)
 Returns the pixel types needed for conversion from packed to unpacked image formats using the CImageFormatConverter class. More...
 
void PylonInitialize (void)
 Initializes the pylon runtime system. More...
 
void PylonTerminate (bool ShutDownLogging=true)
 Frees up resources allocated by the pylon runtime system. More...
 
void GetPylonVersion (unsigned int *major, unsigned int *minor, unsigned int *subminor, unsigned int *build)
 Returns the version number of pylon. More...
 
const char * GetPylonVersionString ()
 Returns the version number of pylon as string.
 
void SetProperty (int propertyId, const void *pData, size_t size)
 Set the value of a property. More...
 
void GetProperty (int propertyId, void *pData, size_t *pSize)
 Get the value of a property. More...
 
VersionInfo GetSfncVersion (GenApi::INodeMap *pNodeMap)
 Helper function for getting the SFNC version from the camera device node map.
 
void GetRTThreadPriorityCapabilities (int &prioMin, int &prioMax)
 Queries the range of allowed thread priorities.
 
int GetRTThreadPriority (THREADHANDLE thread)
 Indicates the current thread priority of a thread.
 
void SetRTThreadPriority (THREADHANDLE thread, int priority)
 Allows to set the realtime thread priority of a threadValues greater than 0 set the thread's static priority and imply realtime scheduling (SCHED_RR scheduling policy). When setting the value 0, non-realtime scheduling is used. The thread's dynamic priority depends on the process' dynamic priority (nice scheduling). More...
 
THREADHANDLE GetCurrentThreadHandle ()
 Get current running thread handle. More...
 
int GetCurrentThreadIdentifier ()
 Get current running thread id. More...
 

Variables

const char *const 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 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 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 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 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 BaslerGenTlDeviceClassPrefix = "BaslerGTC"
 The actual device class string is made up of this prefix + '/' + [TL Vendor] + '/' + [TL Model].
 
const char *const 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 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 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

Contains definitions of pylon types.

Typedef Documentation

STL std::vector like container for Pylon::CDeviceInfo objects.

STL std::vector like container for Pylon::CDeviceInfo objects.

STL std::vector like container for Pylon::CInterfaceInfo objects.

STL std::vector like container for Pylon::CInterfaceInfo objects.

STL std::vector like container for Pylon::CTlInfo objects.

STL std::vector like container for Pylon::CTlInfo objects.

Enumeration Type Documentation

Mode used for transferring images.

The compression mode can have three states. Either compression is disabled in the camera (CompressionMode_Off) or the camera compresses the images in one of two ways (CompressionMode_BaslerLossless or CompressionMode_BaslerFixRatio).

Enumerator
CompressionMode_Off 

Images are transferred uncompressed.

CompressionMode_BaslerLossless 

Images are transferred with Basler lossless compression.

CompressionMode_BaslerFixRatio 

Images are transferred with Basler fixed ratio compression (which may lead to lossily compressed images).

Status of a grab buffer/result with compressed data.

It is possible that images could not be compressed properly by the camera (if the amount of data required for compressing an image exceeds the desired compression ratio). If an image was compressed successfully, it will have the compression status CompressionStatus_Ok.

Enumerator
CompressionStatus_Ok 

Buffer was compressed properly.

CompressionStatus_BufferOverflow 

Size of compressed image exceeded desired compression ratio.

CompressionStatus_Error 

Generic error.

Endianness for parsing the grab buffer/result as defined for the camera technology used.

If not known, Endianness_Auto can be used to detect the endianness automatically. However, this may take longer.

Enumerator
Endianness_Little 

Little endian (e.g., as used in USB3 Vision).

Endianness_Big 

Big endian (e.g., as used in GigE Vision).

Endianness_Auto 

Try to detect endianness automatically.

Lists possible float value correction strategies.

Enumerator
FloatValueCorrection_None 

No correction is applied. If the value isn't valid for the parameter, an exception is thrown.

FloatValueCorrection_ClipToRange 

If the value is not in the valid range, the value is corrected to the valid range.

Lists possible integer value corrections.

Enumerator
IntegerValueCorrection_None 

No correction is applied. If the value isn't valid for the parameter, an exception is thrown.

IntegerValueCorrection_Up 

The value is corrected by rounding up to the nearest valid value. If the value is lower/higher than the minimum/maximum in the range of valid values, the value is corrected to the minimum/maximum.

IntegerValueCorrection_Down 

The value is corrected by rounding down to the nearest valid value. If the value is lower/higher than the minimum/maximum in the range of valid values, the value is corrected to the minimum/maximum.

IntegerValueCorrection_Nearest 

The value is corrected by rounding up or down to the nearest valid value. If the correction in each direction is equal, the value is corrected by rounding up to the nearest valid value. If the value is lower/higher than the minimum/maximum in the range of valid values, the value is corrected to the minimum/maximum.

Lists possible parameter info values.

Enumerator
ParameterInfo_Name 

The identifier of a parameter. It can be used to access the node via a node map using GenApi::INodeMap::GetNode() or to access the value of an enumeration parameter using CEnumParameter::GetEntryByNameAsParameter().

ParameterInfo_DisplayName 

The name of a parameter or an enumeration value that can be used for display in a user interface.

ParameterInfo_ToolTip 

The short description of a parameter or an enumeration value.

ParameterInfo_Description 

The long description of a parameter or an enumeration value.

The return value of the Pylon::WaitObject::WaitEx() and Pylon::WaitObjectEx::WaitEx() methods.

Enumerator
waitex_timeout 

The time-out interval elapsed.

waitex_signaled 

The wait operation completed successfully.

waitex_abandoned 

Windows only (see MSDN for more information)

waitex_alerted 

The wait was interrupted (Windows: queued APC or I/O completion routine; UNIX: signal)

File descriptor ready mask.

Return value of the Pylon::WaitObject::GetReadyMask() method. Indicates to which type of file descriptor set a wait object's file descriptor is to be added when using the file descriptor as input for the select() or poll() function.

Example: When the ready_read bit of a wait object's GetReadyMask() value is set, add the wait object's file descriptor to the read file descriptor set.

Enumerator
ready_none 

The file descriptor is not valid.

ready_read 

The file desriptor is to be added to a read file descriptor set.

ready_write 

The file descriptor is to be added to a write file descriptor set.

ready_except 

The file descriptor is to be added to a exception file descriptor set.

Function Documentation

THREADHANDLE Pylon::GetCurrentThreadHandle ( )
inline

Get current running thread handle.

This wrapper method return the handle of the current running thread.

int Pylon::GetCurrentThreadIdentifier ( )
inline

Get current running thread id.

This wrapper method return the id of the current running thread.

void Pylon::GetProperty ( int  propertyId,
void *  pData,
size_t *  pSize 
)

Get the value of a property.

Parameters
propertyIdIdentifies the property.
pDataA pointer to the buffer containing the data.
pSizeSize of the buffer in bytes when calling. Holds the resulting size on return.

Call this function to get the value of a property.

You must have called PylonInitialize() before you can call this function.

void Pylon::GetPylonVersion ( unsigned int *  major,
unsigned int *  minor,
unsigned int *  subminor,
unsigned int *  build 
)

Returns the version number of pylon.

It is possible to pass a NULL pointer for a version number category if the value is not of interest.

template<class T >
TList<T>::iterator Pylon::operator+ ( intptr_t  iInc,
const typename TList< T >::iterator &  iter 
)

Gets the sum of the given iInc and the given iter.

Parameters
[in]iIncIncrement from which the sum is calculated.
[in]iterIterator from which the sum is calculated.
Returns
Sum of iterator.
void Pylon::PylonInitialize ( void  )

Initializes the pylon runtime system.

You must call PylonInitialize before calling any other pylon functions. When finished you must call PylonTerminate to free up all resources used by pylon.

You can use the helperclass PylonAutoInitTerm to let the compiler call PylonInitialze and PylonTerminate.

Just create a local object on the stack in your main function and the constructor and destructor will call the functions. See PylonAutoInitTerm for a sample.

PylonInitialize/PylonTerminate is reference counted. For every call of PylonInitialize, a call to PylonTerminate is required. The last call to PylonTerminate will free up all resources.

void Pylon::PylonTerminate ( bool  ShutDownLogging = true)

Frees up resources allocated by the pylon runtime system.

Call this function before terminating the application. Don't use any pylon methods or pylon objects after having called PylonTerminate().

PylonInitialize/PylonTerminate is reference counted. For every call of PylonInitialize, a call to PylonTerminate is required. The last call to PylonTerminate will free up all resources.

void Pylon::SetProperty ( int  propertyId,
const void *  pData,
size_t  size 
)

Set the value of a property.

Parameters
propertyIdIdentifies the property.
pDataA pointer to the buffer containing the data.
sizeSize of the buffer in bytes.

Call this function to set the value of a property.

You must have called PylonInitialize() before you can call this function.

void Pylon::SetRTThreadPriority ( THREADHANDLE  thread,
int  priority 
)

Allows to set the realtime thread priority of a threadValues greater than 0 set the thread's static priority and imply realtime scheduling (SCHED_RR scheduling policy). When setting the value 0, non-realtime scheduling is used. The thread's dynamic priority depends on the process' dynamic priority (nice scheduling).

Setting realtime priorities requires certain permissions. The pylon install guide described how to grant an application the permissions to set realtime thread priorities.

Typically a thread that receives image data should be set to realtime thread priorities to reduce jitter and delays. Be aware that such a realtime thread shouldn't perform time consuming tasks (like image processing). A realtime thread that is continuously working can cause the whole operating system to be blocked!


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