"PvDotNet" Tests if a specific serial port is supported on a device. This static method can be used to probe which serial ports are supported by a specific PvDevice. Handle to PvDevice object. The device must be connected. PvDeviceSerial enumeration value representing the device's serial port. True if supported. Returns and sets the capacity of the receive buffer. Returns the number of bytes in the read buffer. Empties the read buffer. Reads from the serial port. Time to wait for new bytes, in milliseconds. Array of bytes read from the serial port. If no bytes are available are the timeout has elapsed, null is returned. Failure can produce a containing one of the following result codes: if the port is not opened or the associated PvDevice is no longer connected.TIMEOUT if no data is available aTimeout milliseconds after calling this method. Reads from the serial port. Array of bytes read from the serial port. If no bytes are immediately available, an empty array is returned. Writes data to the serial port. Bytes to write on the serial port. Number of bytes successfully written on the serial port. Failure can produce a containing one of the following result codes: if the port is not opened or the associated PvDevice is no longer connected. if not all bytes could be written to the serial port. True if the serial port is opened, false if not. Closes the device serial port. Failure can produce a containing the following result code: if the device is not connected. Opens the serial port. The Open method opens a serial port of a device - mainly configuring it for serial communication readiness. Handle to a PvDevice object. The device must be connected prior to opening a serial port. PvDeviceSerial enumeration value representing the device's serial port to open. Failure can produce a containing one of the following result codes: if aDevice is NULL. if the device is not connected. if the port is not supported by the device. Finalizer. Destructor. Constructor Provides access to the serial port on a Pleora video interface GigE Vision device. PvDeviceSerialPort uses a proprietary serial communication protocol on top of the GigE Vision GVCP protocol. It does not support non-Pleora devices. Use of the PvDeviceSerialPort class to directly access the camera head will interfere with the synchronization between the device and the camera head. Avoid accessing device features linked to the camera head while using the PvDeviceSerialPort class to interact with the camera head.

How to use this class

 To use a serial port: Connect to a device using any of the Connect method of PvDevice class.Open a serial port to the device using Open method of PvDeviceSerialPort class.Write to the serial port using Write method of PvSerialPort class.Read from the serial port using Read method of PvSerialPort class.Finally close the serial port using Close method of PvDeviceSerialPort class. To check if an device supports a specific serial port: Connect to a device using any of the Connect method of PvDevice class.Use the IsSupported static method of PvDeviceSerialPort class. Gets and sets the deinterlacer configuration for field inversion. False for 1-2 field order (default) or true for 2-1. Writes the even lines of the output buffer from a buffer containing the even field. Buffer used as source. Buffer used as destination for the operation. Failure can produce a containing one of the following result codes: , if a buffer is NULL or both buffers points to the same data., if the buffers are not properly formatted. Writes the odd lines of the output buffer from a buffer containing the odd field. Buffer used as source. Buffer used as destination for the operation. Failure can produce a containing one of the following result codes: , if a buffer is NULL or both buffers points to the same data., if the buffers are not properly formatted. Deinterlaces an image from a pair of PvBuffers, one Even and one Odd field. used as Odd field source. used as Even field source. used as destination for the operation. Failure can produce a containing one of the following result codes: , if a buffer is NULL or both buffers points to the same data., if both buffers are not similar: width, height, pixel format. Deinterlaces an image from a containing both fields. There is one overload for this method, refer to the other overload method: . used as source. used as destination for the operation. Failure can produce a containing one of the following result codes: , if a buffer is NULL or both buffers points to the same data., if the buffer has an odd number lines. Finalizer. Destructor Constructor De-interlacing filter This class only supports non-destructive (non-in-place) filtering on buffers with an image payload type. It is possible to de-interlace a buffer containing both fields using the #Apply method only taking a single input as parameter. With this method, field inversion can be controlled through . The other method takes two independent objects each containing a field. Even and Odd interlaced fields are required for reconstructions. is ignored when de-interlacing with this method, the user can simply swap the parameters to obtain the same effect. To de-interlace an image: Configure a filter object. Apply the filter. Use PvFilter.Apply. Returns warnings string. Boolean flag to indicate if the pipeline buffers have been reallocated. Warnings string. which can include: buffers reallocated : a BUFFER_TOO_SMALL happened on a received buffer and the pipeline was flushed and all buffers re-allocated resends : SDK detects packets lost and requested resend to IP engine missing block IDs : block IDs missing from blocks sent by device, typically caused by the application not being able to de-queue and re-queue buffers quickly enough pipeline dropped images : The oldest blocks are dropped from the PvPipeline output queue if it runs out of resources. Increasing number of buffers may help device dropped images : device can't keep up with the streaming. Interpacket delay may help with this (InterPacketTimeout) partial lines missing : IPEngine sees either the frame ending early (FVAL goes invalid before the full number of lines) or a line ends early (LVAL goes invalid before the full number of pixels). full lines missing Returns errors string. Errors string. Returns statistics string. Display frame rate to be included in the statistics string. Statistics string. Finalizer. Destructor. Constructor. Reference to the PvStream object to use to build information strings. Class extracting string-based information out of PvStream statistics. This class is used by Pleora applications like eBUSPlayer to provide information on the stream statistics, errors and warnings. While not a core component of the SDK this utility class can be reused in your own application if needed. Resets the last error reported by the object. Returns the last error encountered while trying to open/close the writer or write a frame. Average bitrate of H.264 encoding for the writer. The average bitrate must be set before opening the writer. Closes the writer. Failure can produce a containing one of the following result codes: System error, see error description for more information..H.264 encoding and MP4 recording not supported.If the writer is not opened. Writes a frame to the MP4 file. Note: the image used to open the writer is not encoded or written to the file. If you are using the first image to open the file, you need to call WriteFrame with the same image as well. Image to encode to H.264 and write to the MP4 file. Reference to an integer where the file size delta for encoding/writing this frame is written. Failure can produce a containing one of the following result codes: If there is an issue with one of the parameters.System error, see error description for more information..H.264 encoding and MP4 recording not supported.If the writer is not opened. Opens the writer. The filename of the MP4: full path including the mp4 extension. Image similar in width, height and pixel format to the stream to encode. Failure can produce a containing one of the following result codes: If there is an issue with one of the parameters.System error, see error description for more information..H.264 encoding and MP4 recording not supported. Returns true if the writer is already opened. Returns true if H.264 encoding and MP4 output is supported on the system. Finalizer. Destructor. Constructor. Performs H.264 encoding and writing to an MP4 container from PvBuffers. Call Open with the first image and filename, call write for every buffer (including the first one) and finilize using the Close method. The MP4 file will not be valid until/unless the Close method (or descructor) is executed. Static method used to query the output pixel type for an input image of a specific pixel type. This method can be used if the output buffer provided to Execute is attached and not allocated. The filter can re-allocate an allocated buffer if needed (mismatch on width, height or pixel format) but attached external buffers must be properly formatted before calling Execute. To properly prepare the output buffer, use the same width and height as the input buffer. For the pixel format, use this static method with the input buffer in aBuffer to query the required pixel type of the output buffer. Buffer to return the required output pixel type for. Returns the name of a tap geometry. Index of the geometry: must be between 0 (inclusive) and GetSupportedGeometryCount - 1. Returns the PvTapGeometry enum value of one of the supported tap geometry. Index of the geometry: must be between 0 (inclusive) and GetSupportedGeometryCount - 1. Returns how many tap geometries are supported by this class. Tap geometry used by the filter when performing reconstruction. How many threads are used by the filter. Some filters may not support multi-threading: an exception would be thrown when trying to set to any other value than 0. Executes the filter: performs tap reconstruction on aIn, writing into aOut. The input buffer where data is read from. Must be a PvImage. The output buffer where data is written to. Can be resized if needed if the buffer is allocated. If the buffer is attached, the buffer must be of the right image size and pixel type. Failure can produce a containing one of the following result codes: INVALID_DATA_FORMATGENERIC_ERRORINVALID_PARAMETERSNOT_ENOUGH_MEMORYNOT_SUPPORTED Finalizer. Destructor Constructor Filter used for tap reconstruction. Generic interface for eBUS SDK filters Gets or Sets the priority of the thread used to manage the buffer of the buffer pool Only applicable if using a buffer pool ( See ). The thread will manage the buffer exchange with the transmitter. If you change the thread priorities, it may alternate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities. Gets or Sets the priority of the thread in charge of sending the packets on the network. Only applicable if using a user-mode transmitter. The thread priority of a driver-based transmitter cannot be controlled. Thread that is responsible for breaking buffers in packets and transmitting them. If you change the thread priorities, it may alternate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities. Gets the average transmission rate (in blocks/second). Average transmission rate is equivalent to BlocksTransmitted / SamplingTime. This function is the transmitter counterpart to the property AcquisitionRateAverage of PvStatistics. Gets the instantaneous transmission rate (in blocks/second). Instantaneous transmission rate is measured using a short time frame. This function is the transmitter counterpart to the property AcquisitionRate of PvStatistics. Gets the average payload throughput (in bps). Average payload transmission rate is equivalent to PayloadBytesTransmitted * 8 / SamplingTime. Note that this calculation only includes the number of useful data bytes and does not include GVSP, IP and UDP header overhead. This function is the transmitter counterpart to property BandwidthAverage of PvStatistics. Gets an instantaneous calculation of the payload throughput (in bps). Instantaneous payload transmission rate is measured using a short time frame. Note that this calculation only includes the number of useful data bytes and does not include GVSP, IP and UDP header overhead. This function is the transmitter counterpart to property Bandwidth of PvStatistics. Gets the number of payload bytes transmitted. Note that this value only includes the number of useful data bytes and does not include GVSP, IP and UDP header overhead. Gets the time since last reset. The time, in ms, since the counters were zeroed; the time since the object was created, the transmitter was opened (using Open), or ResetStats was called. Returns the number of blocks transmitted. Zero all running counters. Returns the source IP address to which blocks are transmitted. Returns an empty string when a connection has not yet been opened. Gets the destination IP address to which blocks are transmitted. Returns an empty string when a connection has not yet been opened. Gets the destination port from which blocks are transmitted. Returns 0 when a connection has not yet been opened. Gets the source port from which blocks are transmitted. Returns 0 when a connection has not yet been opened. Gets or sets the maximum desired effective throughput in bps. An occasional delay is placed between the packets being transmitted to attempt to throttle the effective throughput. This helps to spread out network traffic to optimize bandwidth availability for other applications. A value of 0 (default) indicates that there should be no throttling based on throughput. The throughput is measured in effective throughput on the content of the transmitted PvBuffer objects. It does not take into account the GigE Vision, UDP, IP and Ethernet protocol overhead of the packetized data. Gets or sets the maximum packet size (in bytes) of GVSP payload packets. When a block is packetized and transmitted, the payload is broken down into packets of a given size. The default value for the maximum packet size is 1440 because that is the size that should work in theory for all network adapters. For best results, enable jumbo packets in your network adapter properties and increase the maximum packet size to match When sending very small blocks at high frame rates it may sometimes be desirable to set the maximum packet size to a lower number. Returns the number of buffers queued for transmission including the ones that are currently being sent. Abort all pending transmission requests. Buffers that were aborted will have an operation result set at . Represents the maximum number of milliseconds to wait for the completion of the current buffer transmission before forcing an abort. If this timeout expires and forces the system to send a partial buffer, the parameter aPartialTransmission will be set to true ( when supplied ). Optional parameter set to true when the aTimeout expires and a partial image was sent. Failure can produce a containing one of the following result codes: Abort all pending transmission requests. Buffers that were aborted will have an operation result set at . Represents the maximum number of milliseconds to wait for the completion of the current buffer transmission before forcing an abort. If the abort is forced, the a block can be partially sent. Failure can produce a containing one of the following result codes: Abort all pending transmission requests. Buffers that were aborted will have an operation result set at . This function will wait for the completion of the current block before aborting. Failure can produce a containing one of the following result codes: Retrieve a free buffer from the list of available buffers. The buffer that is available to populate and transmit. The object handle is set to NULL if no buffer is available. The maximum number of milliseconds to wait for a free buffer to become available. A free buffer from the list of available buffers. Failure can produce a containing one of the following result codes: OK, if successful.NOT_CONNECTED, the device is not connected.INVALID_PARAMETER, invalid data. Retrieve a free buffer from the list of available buffers. The buffer that is available to populate and transmit. The object handle is set to NULL if no buffer is available. A free buffer from the list of available buffers. Failure can produce a containing one of the following result codes: OK, if successful.NOT_CONNECTED, the device is not connected.INVALID_PARAMETER, invalid data. Queue one buffer in to be transmitted when a connection is available. The buffer to transmit. Failure can produce a containing one of the following result codes: OK, if successful.NO_LICENSE, no transmitter for non-image types.PENDING, The queue is pending. Load a set of free buffers into the pool. This method provides the transmitter with a set of free buffers that can be retrieved immediately by calling RetrieveFreeBuffer. An array of handles to PvBuffer objects. Failure can produce a containing one of the following result codes: OK, if successful.INVALID_PARAMETER, invalid data. Returns whether a connection is available to begin transmitting blocks. Call Open to ensure that the tranmitter knows where to begin transmitting blocks. Return True if a connection is available. False if no connection is available. Stop sending data and close the socket. Any buffers that are in the middle of being transmitted are aborted. Initialize a socket to begin transmitting data. Once this call is completed successfully, the transmitter will begin sending blocks as soon as the first buffer is queued in by calling QueueBuffer. The address to which the transmitter will send. The port to which the transmitter will send. The address from which the transmitter will send. If the parameter is an empty string (default), the socket will not be bound to a particular local IP address. The port from which the transmitter will send. If the parameter is 0 (default), the source port will be dynamically assigned by the operating system. The value of the Don't Fragment flag in the IP header. The default value is true. Use the extended id for the blocks and the packets when set to true. The default value is false. ( Not supported in this version of the SDK. ) Maximum number of buffer that can be stored simultaneously in the lower layer of the transmitter. Set the timestamp in the buffer header before sending the packets. if the socket could not be created. Initialize a socket to begin transmitting data. Once this call is completed successfully, the transmitter will begin sending blocks as soon as the first buffer is queued in by calling QueueBuffer. The address to which the transmitter will send. The port to which the transmitter will send. The address from which the transmitter will send. If the parameter is an empty string (default), the socket will not be bound to a particular local IP address. The port from which the transmitter will send. If the parameter is 0 (default), the source port will be dynamically assigned by the operating system. The value of the Don't Fragment flag in the IP header. The default value is true. Use the extended id for the blocks and the packets when set to true. The default value is false. ( Not supported in this version of the SDK. ) Maximum number of buffer that can be stored simultaneously in the lower layer of the transmitter. if the socket could not be created. Initialize a socket to begin transmitting data. Once this call is completed successfully, the transmitter will begin sending blocks as soon as the first buffer is queued in by calling QueueBuffer. The address to which the transmitter will send. The port to which the transmitter will send. The address from which the transmitter will send. If the parameter is an empty string (default), the socket will not be bound to a particular local IP address. The port from which the transmitter will send. If the parameter is 0 (default), the source port will be dynamically assigned by the operating system. The value of the Don't Fragment flag in the IP header. The default value is true. Use the extended id for the blocks and the packets when set to true. The default value is false. ( Not supported in this version of the SDK. ) if the socket could not be created. Initialize a socket to begin transmitting data. Once this call is completed successfully, the transmitter will begin sending blocks as soon as the first buffer is queued in by calling QueueBuffer. For information about the default argument parameters bool aExtendedID of this overload method, refer to the other overload method . The address to which the transmitter will send. The port to which the transmitter will send. The address from which the transmitter will send. If the parameter is an empty string (default), the socket will not be bound to a particular local IP address. The port from which the transmitter will send. If the parameter is 0 (default), the source port will be dynamically assigned by the operating system. The value of the Don't Fragment flag in the IP header. The default value is true. if the socket could not be created. Initialize a socket to begin transmitting data. Once this call is completed successfully, the transmitter will begin sending blocks as soon as the first buffer is queued in by calling QueueBuffer. For information about the default argument parameters bool aDontFrag, bool aExtendedID of this overload method, refer to the other overload method . The address to which the transmitter will send. The port to which the transmitter will send. The address from which the transmitter will send. If the parameter is an empty string (default), the socket will not be bound to a particular local IP address. The port from which the transmitter will send. If the parameter is 0 (default), the source port will be dynamically assigned by the operating system. if the socket could not be created. Initialize a socket to begin transmitting data. Once this call is completed successfully, the transmitter will begin sending blocks as soon as the first buffer is queued in by calling QueueBuffer. For information about the default argument parameters String uint16_t aSourcePort, bool aDontFrag, bool aExtendedID of this overload method, refer to the other overload method . The address to which the transmitter will send. The port to which the transmitter will send. The address from which the transmitter will send. If the parameter is an empty string (default), the socket will not be bound to a particular local IP address. if the socket could not be created. Initialize a socket to begin transmitting data. Once this call is completed successfully, the transmitter will begin sending blocks as soon as the first buffer is queued in by calling QueueBuffer. This overload method Open has four default argument parameters, for information about these four default argument parameters String ^aSourceIp, uint16_t aSourcePort, bool aDontFrag, bool aExtendedID of this overload method, refer to the other overload method . The address to which the transmitter will send. The port to which the transmitter will send. if the socket could not be created. Finalizer. Destructor. Constructor. Class for transmitting blocks using the GigE Vision streaming protocol. Procedure for transmitting blocks (images or raw data) with the eBUS SDK: Ensure that the transmitter knows where to send blocks by calling Open.Initialize the transmitter with a set of free buffers (PvBuffer objects) by calling .Retrieve a free buffer to populate by calling RetrieveFreeBuffer.Queue a buffer for transmission by calling QueueBuffer.Once a buffer has been transmitted, it can be retrieved again by calling RetrieveFreeBuffer. The following code snippet illustrates procedure above: The status of a given PvBuffer object can be retrieved by calling OperationResult property of PvBuffer. An operation result of indicates that the buffer was transmitted successfully.An operation result of indicates that there was a problem transmitting the buffer (likely due to a lack of connectivity).An operation result of indicates that the transmission of that buffer was aborted (typically by calling AbortQueuedBuffers).An operation result of indicates that the buffer has not yet been fully transmitted. To receive transmitted blocks with a PvStream application (such as eBUS Player), the transmitting application must be set up to respond to device discovery requests. Use PvVirtualDeviceGEV to respond to device discovery requests. If using eBUS Player or NetCommand to receive data being transmitted with this class, ensure that the application is set up as Data Receiver Only. For an illustration of how this API is used in practice, refer to the following source code samples in the samples directory where the eBUS SDK resides. TransmitTestPattern- Transmits a test pattern to a given destination. This is the easiest starting point for learning to use PvTransmitterGEV.TransmitTiledImages - GUI application that receives video from multiple GEV transmitters, tiles into one video feed and transmits to a given destination. Returns the device hard-coded baud rate (user-defined). Zero (0) is returned if the bridge is not started or in serial COM port mode. Sets the device hard-coded baud rate (user-defined) If the device GenICam interface does not have the features to control the configuration of the serial port used by the bridge, the developer must know and provide the baud rate to which the serial port is hard-coded. This hard-coded baud rate is only used to control which unique baud rate is made available to the application or CLProtocol DLL using the Camera Link DLL. This unique baud rate must match the hard-coded device serial port baud rate. This method should be called after starting the Camera Link DLL bridge, but before starting the application using the Camera Link DLL or before creating the CLProtocol node map. With a serial COM port, the baud rate of the COM port is specified through the PvSerialPortConfiguration parameter passed to the Start method and simply isn't used to set the device serial port baud rate. The hard coded baud rate does not need to be defined. If the device GenICam interface does not have the features to control the configuration of the serial port and this method is not called to specify the hard-coded baud rate of the serial port, 9600 baud is used/assumed. Valid baud rates are the intersection between the device serial port baud rates and what is described in the Camera Link specification: 9600 baud.19200 baud.38400 baud.57600 baud.115200 baud. Failure to set the device hard-coded baud rate can produce a PvException of the following result codes: if the bridge is not started. if the baud rate is not supported. if the bridge is not in Camera Link DLL mode. Returns the active baud rate of the device serial port used by the bridge. Zero (0) is returned if the bridge is not active. If the device serial port baud rate cannot be retrieved, the serial COM port baud rate is returned if the bridge is used on a serial COM port. If the bridge is used on a Camera Link DLL, the hard-coded baud rate specified using the HardCodedBaudRate property is returned. Returns an indexed baud rate supported by the device. Zero-based supported baud rate index. Indexed supported baud rate. Used with SupportedBaudRateCount property to enumerate all supported baud rates by the device serial port used by the bridge. Zero (0) is returned if the baud rates of the device serial port could not be determined from its GenICam interface or if the bridge is not active. Zero-based supported baud rate index. Returns how many baud rates are supported by the device serial port. Used with SupportedBaudRate property to enumerate all supported baud rates by the device serial port used by the bridge. Zero (0) can be returned if the GenICam interface of the device does not allow serial port configuration. Closes and re-opens the device serial port. Re-initialization of the device serial port is required after a loss of connection. cref="PvException">Failure can produce a of the following result codes: if the bridge is not started. Returns the bridge name used when clserpte.dll enumerates ports. Empty string if the bridge is not started in Camera Link DLL mode. Returns the serial port configuration string used to start the bridge in serial port mode. An invalid configuaration is returned if the bridge is not started or in Camera Link DLL mode. Returns the serial port string used to start the bridge in serial port mode. Empty string if the bridge is not started or in Camera Link DLL mode. Returns the device port used by the bridge. PvDeviceSerialInvalid if the bridge is not started. Resets the bridge statistics. Has not effect if the bridge is not started. Returns the number of bytes received from the device by the bridge. Zero if the bridge is not started. Returns the number of bytes sent to the device by the bridge. Zero if the bridge is not started. Stops the serial bridge. Failure can produce a following result code: if the bridge is not running. Starts the serial bridge using a serial port as the source. Name used when enumerating bridges (ports) with clserpte.dll. Handle to a connected PvDevice used to open the device-side serial port. Device port to bridge to. Example: PvIPEngineBulk0. Failure can produce a containing one of the following result codes: Starts the serial bridge using a Camera Link DLL (clserpte.dll) as the source. Supported baud rates are 9600, 14400, 19200, 28800, 38400, 57600, 115200. For parity, none/even/odd are supported and expressed as N/E/O. Supported bit counts are 7 and 8. Supported stop bits are 1 and 2. Handle to a string identifying which serial port on the host to use. Example: "COM1". Handle to an object containing the serial port configuration to be applied on aSerialPort. Handle to a connected PvDevice used to open the device-side serial port. Device port to bridge to. Example: PvIPEngineBulk0. Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor. Bridges a COM port of Camera Link DLL to a device serial port. Notes: This class is only available on Windows. The serial bridge takes all the data coming from either a COM port or eBUS SDK Camera Link DLL (clserpte.dll) and sends to a device serial port. It also takes all the data coming from a device serial port and sends it to either a COM port or eBUS SDK Camera Link DLL. Depending on the Start method that is used, the bridge is either started as a COM port bridge or Camera Link DLL bridge. Statistics can be retrieved about a bridge: count of transmitted and received bytes. The COM port can be used with a stand-alone application, usually a camera configuration application relying on a COM port (ie: COM1, COM2, etc.) to interact with the camera. The port selected by the application must be connected with a NULL modem to the port used by the bridge. It can be two real COM ports connected together or two virtual ports with a COM port emulation software/driver. The Camera Link DLL can be used with a stand-alone application, usually a camera configuration application, relying on the API described in the Camera Link standard used to interface a serial port. Instead of being the serial port of a frame grabber here it is the serial port of a GigE Vision device. The Camera Link DLL can also be used with a PvGenParameterArrayCL - a GenICam CLProtocol interface. Major version. D in vA.B.C.D. Major version. C in vA.B.C.D. Major version. B in vA.B.C.D. Major version. A in vA.B.C.D. Complete version string. Comment. Trademark string. Copyright string. Product name. Company name. Static strings providing version information about the eBUS SDK. Makes the content of the object invalid. Validates the content of the object. Failure can produce a containing one of the following result codes: if a parameter is not properly set. Use to get more information. Returns and sets the stop bits. Returns and sets the byte size. Returns and sets the parity bit. Returns and sets the baud rate. Finalizer. Destructor. Constructor fully configuring the object. The baud rate of COM port. The parity bit of COM port. The byte size of COM port. The stop bit of COM port. Default constructor. (PC side) COM port configuration to set on a PvSerialBridge. Parity bit enumeration. Odd parity bit. Even parity bit. None parity bit. Invalid parity bit. Generates a reset record from a firmware update file. Name of the firmware file to read the version and attributes from. New device Id. Memory buffer where to write the reset record. Length of the memory buffer, in bytes. How many effective bytes were written to the buffer. Generates a reset record from a firmware update file. Name of the firmware file to read the version and attributes from. Memory buffer where to write the reset record. Length of the memory buffer, in bytes. How many effective bytes were written to the buffer. Finalizer. Destructor. Constructor, works on a memory buffer. Pointer to the buffer of the payload to work on. Length of the memory buffer, in bytes. Constructor, works a on file. Filename of the payload file to work on. Currently only used to generate reset and device ID DFW records from firmware update files. This class may eventually be instantiated to perform DFW files manipulation. However, for the time being it only provides a fixed set of static functions used to generate ready-to-use DFW records. Get/Set the priority of the thread used for GigE Vision control channel. This thread listening for the virtual device on the GigE Vision control channel. Handles read register, device discoveries, etc. If you change the thread priorities, it may alternate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities. Failure can produce a containing one of the following result codes: Stop responding to GVCP traffic and close the connection. Begin responding to GVCP traffic on the specified network interface. A PvVirtualDeviceGEV object listens for traffic on one socket at a time. To listen for GVCP traffic on more than one network interface, instantiate another PvVirtualDevice object. Information that identifies the network interface with which the virtual device will begin responding to GVCP traffic. - Network interface's MAC address. Use the form 00:11:22:33:44:5F. - IP address that should already be associated with a given network adapter. Use the form 192.168.1.114. Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor. Virtual GigE Vision device. Used to provide basic GigE Vision device capabilities such as device discovery. Can complement the PvTransmitterGEV class by allowing one to open a data receiver connection to it using . Proper use of the PvVirtualDeviceGEV class is demonstrated in all transmitter samples. Saves the configuration to a configuration file Configuration writer to which filter is saved. Failure can produce a containing one of the following result codes: Loads the configuration from a configuration file Configuration reader from which to load the configuration. Failure can produce a containing one of the following result codes: Region of interest on used to analyze the image. Only the pixels inside the region of interest are considered. Standard deviation of the pixels in the ROI in the last analyzed image. Average of the pixels in the ROI in the last analyzed image. Resets the configuration and results of the analysis object. Retrieves histogram information about the last processed image. Copies the histogram data in a buffer. aMaxValue The maximum value for one histogram bin. aHistogram Pointer to a buffer where to copy the histogram data. Failure can produce a containing one of the following result codes: Analyze a buffer. Computes the histogram, average, etc. on the input buffer. Use the class properties to retrieve the information about calling this method. Input image buffer. Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor Performs image analyse on an image. Call the Process method on a PvBuffer and the use accessors to retrieve information extracted from the image. Provides a text overlay for the buffer about to be displayed. The display thread only generate the overlay update events. What to do with the overlay is left to the code handling this event. See delegate documentation for more information. When buffer logging is enabled, log entries are reported using this event. The display thread only generate log events. How logging is performed is the responsibility of the application using the display thread. See delegate documentation for more information. The display thread has finished handling a buffer. See delegate documentation for more information. A buffer needs to be displayed. If the acquisition frame rate is higher than the target FPS some buffers may end up not being displayed. Additional processing may be performed before displaying the image. This step is optional and left to the application. The display thread does not perform image processing. If interlacing is enabled and an interlaced stream is handled by the display thread, the final buffer being displayed is a buffer that is not directly retrieved from the pipeline (and reported through OnBufferRetrieved). It is a buffer owned by the display thread used for image reconstruction from received field buffers. See delegate documentation for more information. A buffer was retrieved from the PvPipeline. If interlacing is enabled and an interlaced stream is handled by the display thread, the final buffer being displayed is a buffer that is not directly retrieved from the pipeline (and reported through OnBufferRetrieved). It is a buffer owned by the display thread used for image reconstruction from received field buffers. See delegate documentation for more information. Restores a display thread options. The load works on a best effort basis. Whatever can be restored will be restored. The order to properties in the aPropertyList is not important. Defined as virtual. Can override in order to load configuration specific to specialized classes. A list of name/value pairs. Persists the display thread configuration. This call builds a list of properties containing pairs of names/values. Defined as virtual. Can override in order to save configuration specific to specialized classes. Call the base implementation first. A list of name/value pairs. Resets the thread display statistics. Sets the tap geometry to be used to tap reconstruction. If set to a valid tap geometry, tap reconstruction is performed before displaying the image. Use PvTapGeometry.Unknown to disable - which is also the default. Sets if the data chunks should be displayed as a text overlay. The specialized class must implement the right overloaded method in order to receive text overlay updates from this class. Vertical synchronization flag. The display thread does not use this flag, it only keeps it value so it can be read by specialized classes to request a vertical synchronization when a buffer is displayed. This flag will only have an effect if it is used when the specialized class. Not all display implementations support vertical synchronization. Target displayed frames per second. If the acquisition frame rate is higher than TargetFPS frames are dropped and not displayed. OnBufferDisplay is only invoked on frames that need to be displayed in order to meet TargetFPS. Returns the effective displayed frames per second. How interlaced fields are handled by the display thread. If true, log events are generated for all buffers. If true, log events are generated for buffer errors. If true, attempts to display images with missing packets or lines. If true, attempts to display images with missing packets or lines. Returns the latest buffer and blocks the pipeline while the buffer is accessed. MUST call ReleaseLatestBuffer when done. This method should not be on each and every buffers. Use the callbacks instead. A PvBuffer managed wrapper is created on each call to RetrieveLatestBuffer and the display thread is blocked until ReleaseLatestBuffer. A valid example of RetrieveLatestBuffer would be getting the last acquired image in order to perform on white balance on a RGB filter that is handled outside of the display thread. The latest buffer. Display thread priority. True if the thread is running. Waits for the display thread to terminate. Stops the display thread. If true, waits for the thread to terminate. If false you can use WaitComplete. Starts the display thread. PvPipeline the display thread is working from. Optional parameters. Specify to have the display thread manage data chunks. Finalizer. Destructor. Constructor. Thread taking buffers out of a PvPipeline in order to display them. Register delegates to the events of a PvDisplayThread in order to receive notifications. The most common use of the display thread requires to register the OnBufferDisplay and handle buffer displaying in the handler. PvDisplayThread buffer text overlay is updated event delegate. Reference to the display thread object that invoked the delegate. Text overlay generated by the display thread handling the current buffer. PvDisplayThread buffer log entry was generated event delegate. Reference to the display thread object that invoked the delegate. Log entry generated by the display thread handling the current buffer. PvDisplayThread finished using a buffer event delegate. Reference to the display thread object that invoked the delegate. Reference to the buffer. PvDisplayThread buffer needs to be displayed event delegate. Reference to the display thread object that invoked the delegate. Reference to the buffer. PvDisplayThread buffer was retrieved from the PvPipeline event delegate. Reference to the display thread object that invoked the delegate. Reference to the buffer. Tap geometries enumeration. Deinterlacing type. Each incoming field has its lines doubled at full acquisition rate. Lines of consecutive fields are blended (averaged) and then doubled at full acquisition rate. Incoming fields are weaved together at full acquisition rate. Consecutive fields are weaved together at 1/2 their acquisition rate. No deinterlacing is performed on interlaced fields. PvPipeline event sink OnBufferTooSmall event. Invoked when the pipeline retrieve a buffer from the stream object which failed with an operation result set to BUFFER_TOO_SMALL. The user can set the delegate aReallocAll parameter to true in order to force a complete re-allocation of the buffers performed synchronously after the notification is invoked. If OnBufferTooSmall is not handled or the delegate aReallocAll parameter is set to false, the buffer is re-allocated before being queued in the stream object but the other buffers are not affected until they too will fail on BUFFER_TOO_SMALL. The delegate aResetStats parameter is only considered if the delegate aReallocAll is set to true. The statistics do not need to be reset if the buffers are not re-allocated. This callback is invoked from the pipeline thread. See delegate documentation for more information. PvPipeline event sink OnReset event. Invoked after the pipeline has been reset. This callback is invoked from the same thread that called PvPipeline.Reset. See delegate documentation for more information. PvPipeline event sink OnStop event. Invoked right after the pipeline has been stopped. This callback is invoked from the same thread that called PvPipeline.Stop. See delegate documentation for more information. PvPipeline event sink OnStart event. Invoked when the pipeline just before the pipeline starts. This callback is invoked from the same thread that called PvPipeline.Start. See delegate documentation for more information. \Called whenever a PvBuffer is deleted by the pipeline. Can be used to track memory usage or structures used to follow PvBuffer pipeline management. This method is invoked right before the PvBuffer is deleted. See delegate documentation for more information. Called whenever a PvBuffer is allocated by the pipeline. Can be used to track memory usage or structures used to follow PvBuffer pipeline management. This method is invoked right after the PvBuffer has been created but before its payload has been allocated. See delegate documentation for more information. Set / Get the priority of the pipeline thread. This thread is pretty much the pipeline itself: it queues buffers in PvStream and retrieves them when they are ready, making them available in an output queue. If you change the thread priorities, it may alternate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities. Reset the PvPipeline. Stop the PvPipeline. Start the PvPipeline. The PvResult. Releases image buffer to the PvPipeline. Handle to the PvBuffer object. The PvResult. Get image buffers, operation result within specified time out. Handle to the PvBuffer object. Retrieve buffer time out. Operation result. The PvResult. Get image buffers within specified time out. Handle to the PvBuffer object. Retrieve buffer time out. The PvResult. Get image buffers. Handle to the PvBuffer object. The PvResult. Configures whether the pipeline handles BUFFER_TOO_SMALL operation result or not. If the pipeline is configured to handle BUFFER_TOO_SMALL operation results the buffers are automatically re-allocated and re-queued for acquisition when this condition occurs. If the pipeline is not configured to handled BUFFER_TOO_SMALL operation results the buffers are queued in the pipeline output queue just as any other buffer and what to do with the buffer is deferred to the application using PvPipeline. If the pipeline handles BUFFER_TOO_SMALL operation results, the OnBufferTooSmall delegate is invoked in order to order to query how to handle the condition. If not implemented the default behaviour is applied. See documentation about the OnBufferTooSmall delegate for more information. The OnBufferTooSmall delegate is not invoked when the pipeline is not configured to handle BUFFER_TOO_SMALL operation results. Returns and set buffer count. Returns and set buffer size. Each time a buffer is queued into the data receiver, it is re-allocated as necessary according to the following behavior: if the buffer size is less than the require buffer size (BUFFER_TOO_SMALL) it is re-allocated. If the buffer size is more than four times the required buffer size, it is re-allocated in order to save memory. Originally the buffer size can be specified using SetBufferSize. The pipeline automatically adjusts the buffer size based on incoming buffers. As buffers are returned to the pipeline and being queued by the data receiver they may be re-allocated as described above. Default size used to allocate buffers if no buffer size information is available. This method is deprecated. Should use GetBufferSize and SetBufferSize instead Returns true if pipe line is started, otherwise return false. Returns the output queue size. Finalizer. Destructor. Constructor. Handle to PvStream object. Helper class for receiving data from a GigE Vision or USB3 Vision transmitter. PvPipeline manages the PvBuffer and acquisition thread. PvPipeline partners with a PvStream or PvStreamRaw object to allocate and push buffers into the data receiver as needed. Only applied to simple acquisition scenarios. Only responsible of receiving images. Buffers are silently dropped when the out-queue of the PvPipeline is full. Does not interact with the device. PvPipeline buffer too small event delegate. Reference to the PvPipeline object that invoked the delegate. Output parameter: if set to true by the delegate handler, all buffers of the pipeline will be re-allocated immediately. If set to false, buffers are re-allocated one-by-one as they fail with BUFFER_TOO_SMALL operation result. Output parameter: if true, the statistics are reset following buffers re-allocation. PvPipeline reset event delegate. Reference to the PvPipeline object that invoked the delegate. PvPipeline acquisition stop event delegate. Reference to the PvPipeline object that invoked the delegate. PvPipeline acquisition start event delegate. Reference to the PvPipeline object that invoked the delegate. PvPipeline buffer deleted event delegate. Reference to the PvPipeline object that invoked the delegate. Reference to the PvBuffer that was just deleted. PvPipeline buffer created event delegate. Reference to the PvPipeline object that invoked the delegate. Reference to the PvBuffer that was just created. Sets the GigE Vision device's IP address. This static method lets you configure the GigE Vision device's IP address. You cannot change the IP address when a PvDevice is connected. Can be used to assign a valid IP configuration to a device before connecting a to a GigE Vision device (using the method). The GigE Vision device to be configured is identified using its MAC address. The GigE Vision device's MAC address. The GigE Vision device's new IP address. The GigE Vision device's new subnet mask. The GigE Vision device's new gateway. Failure can produce a containing one of the following result codes: Returns the current access type of a device identified by its IP address. This function is static. It does not work on an specific object but will return the access type of a GigE Vision device identified by its IP address. IPAddress The IP address of the GigE Vision device. Current access type of a device identified by its IP address. Failure can produce a containing one of the following result codes: Write a 32-bit value to a specific register address on the GigE Vision device. See warnings about accessing the register map directly in . aValue is provided in the platform's expected Endianess. GigE Vision single register operations are always performed as Big Endian and on Intel platforms are corrected to/from Little Endian. The GigE Vision device's register address (mod 4). The value to be written to the register. When sending the command, sets the acknowledge requested bit and waits for that acknowledge. If set to false, the acknowledge is not requested and the method returns as soon as the command has been pushed in the UDP socket. If not specified true is assumed. Failure can produce a containing one of the following result codes: Write a 32-bit value to a specific register address on the GigE Vision device. See warnings about accessing the register map directly in . aValue is provided in the platform's expected Endianess. GigE Vision single register operations are always performed as Big Endian and on Intel platforms are corrected to/from Little Endian. The GigE Vision device's register address (mod 4). The value to be written to the register. Failure can produce a containing one of the following result codes: Read a 32-bit value from a specific register address on the GigE Vision device. aValue is returned in the platform's expected Endianess. GigE Vision single register operations are always performed as Big Endian and on Intel platforms are corrected to/from Little Endian. The GigE Vision device's register address (mod 4). The value read from the GigE Vision device's register. Failure can produce a containing one of the following result codes: Automatically finds and sets the optimal packet size. The method tests the network connection for the largest possible packet size that the network can support between the GigE Vision transmitter and the controlling PC. The streaming channel. Use 0 for most GigE Vision devices only supporting a single streaming channel. The packet size to use, in bytes, should the negotiation fail. Use 1476 for a safe packet size; 0 to continue using the GigE Vision device's original setting in case of failure. Failure can produce a containing one of the following result codes: Automatically finds and sets the optimal packet size. The streaming channel. Use 0 for most GigE Vision devices only supporting a single streaming channel. Failure can produce a containing one of the following result codes: Automatically finds and sets the optimal packet size. This method tests the network connection for the largest possible packet size that the network can support between the GigE Vision transmitter and the controlling PC. Calling this method resets the streaming destination for aChannel. You should always call this method AFTER connecting, BEFORE setting the GigE Vision streaming destination using SetStreamDestination. Failure can produce a containing one of the following result codes: Sets the packet size for a streaming channel. Applies a specific packet size to a streaming channel. Unlike the NegotiatePacketSize method, it does not attempt to find the best packet size, it just uses the one provided as a parameter. The packet size to use for aChannel. The streaming channel. Use 0 for most GigE Vision devices only supporting a single streaming channel. Failure can produce a containing one of the following result codes: Sets the packet size for a streaming channel. Applies a specific packet size to a streaming channel. Unlike the NegotiatePacketSize method, it does not attempt to find the best packet size, it just uses the one provided as a parameter. The packet size to use for aChannel. Failure can produce a containing one of the following result codes: Resets the UDP/IP streaming destination of the GigE Vision device. This method is equivalent to calling with values ("0.0.0.0", 0, aChannel). See the aChannel parameter for the method. Failure can produce a containing one of the following result codes: Resets the UDP/IP streaming destination of the GigE Vision device. This method is equivalent to calling with values ("0.0.0.0", 0). Failure can produce a containing one of the following result codes: Set the UDP/IP destination to which the GigE Vision device transmits data. The destination consists of an IP address (unicast or multicast) and a port number. The receiving PC's IP address (GenICam feature name: GevSCDA) or a multicast IP address. The receiving PC's data port (feature name: GevSCPHostPort) or the multicast port. The GigE Vision stream channel; the channel over which the GigE Vision device transmits images. Use 0 for device having supporting a single streaming channel. Failure can produce a containing one of the following result codes: Set the UDP/IP destination to which the GigE Vision device transmits data. The destination consists of an IP address (unicast or multicast) and a port number. The receiving PC's IP address (GenICam feature name: GevSCDA) or a multicast IP address. The receiving PC's data port (feature name: GevSCPHostPort) or the multicast port. Failure can produce a containing one of the following result codes: Connect to a GigE Vision device. If you know the GigE Vision device's IP address, MAC address or DeviceUserID, you can use this method to connect to it. 1. If aInfo contains an IP address, the connection attempt is direct. 2. If aInfo contains a MAC address or DeviceUserID: An internal is used to find all reachable GigE Vision devices.Found devices are browsed, looking for a match on either MAC address or DeviceUserID.If the device is found, connection is attempted. Information that uniquely identifies the GigE Vision device. You may use one of the following: - GigE Vision device's MAC address. Use the form 00:11:22:33:44:5F. - GigE Vision device's IP Address. Use the form 192.168.1.114. - GigE Vision device's DeviceUserID. The access control privilege to set at the time of connection (default ). See . Failure can produce a containing one of the following result codes: Connect to a GigE Vision device (found with , , ). The method connects to a GigE Vision device found using a or PvDeviceFinderWnd object. Only one device can be connected to at a time. The GigE Vision device's network connectivity information; a object. The GigE Vision device's availability for connections by multiple controllers.. Failure can produce a containing one of the following result codes: Connect to a GigE Vision device. The method connects to a GigE Vision device found using a or PvDeviceFinderWnd object. Only one device can be connected to at a time. The GigE Vision device's network connectivity information; a object. Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor. Connect, configure and control a GigE Vision device. Retrieve a reply from a camera (for cameras with memory offsets). The camera's I2C slave address (7-bits). The address offset of the slave in question. The size of the internal read buffer. Set to the maximum of bytes that can be received on a single read operation. The I2C bus speed. Default value is True for I2C's Fast mode (400 Kbits/s); false for Standard mode (100 Kbits/s). True if a stop should be issued between the write and read sequence; false if no stop is required. A byte array containing the bytes read from the I2C bus. Failure can produce a containing one of the following result codes: if the port is not initialized. if the port is not opened or the associated PvDevice is no longer connected. if not all bytes could be written to the serial port. TIMEOUT if no data is available after calling this method. Retrieve a reply from a camera. There is one overload for this method with default argument parameter bool aFastMode ( The I2C bus speed. Default value is True for I2C's Fast mode (400 Kbits/s); false for Standard mode (100 Kbits/s). The camera's I2C slave address (7-bits). The size of the internal read buffer. Set to the maximum of bytes that can be received on a single read operation. The I2C bus speed. Default value is True for I2C's Fast mode (400 Kbits/s); false for Standard mode (100 Kbits/s). A byte array containing the bytes read from the I2C bus. Failure can produce a containing one of the following result codes: if the port is not initialized. if the port is not opened or the associated PvDevice is no longer connected. if not all bytes could be written to the serial port. TIMEOUT if no data is available after calling this method. Send a command to the camera (for cameras with memory offsets). Before using this method, see BurstWrite. The IndirectBurstWrite method is very similar to the BurstWrite method, with the following exceptions: This method includes a memory offset, aOffset, that lets you write to a series of memory addresses in the camera. The camera's I2C slave address (7-bits). The address offset of the slave in question. Data being written on the I2C bus. The I2C bus speed. Default value is True for I2C's Fast mode (400 Kbits/s); false for Standard mode (100 Kbits/s). Failure can produce a containing one of the following result codes: if the port is not initialized. if the port is not opened or the associated PvDevice is no longer connected. if not all bytes could be written to the serial port. Send a command to the camera. Before using BurstWrite, confirm it meets your camera's requirements: If your I2C-capable camera uses a single memory location (for the entire streamed message, use BurstWrite and BurstRead. If it uses sequential memory (storing messages in a series of bytes in memory), use IndirectBurstWrite and IndirectBurstRead. The BurstWrite method sends a message, aBuffer, to the I2C-capable camera defined by aSlaveAddress.If the camera doesn't acknowledge a byte during the burst write, BurstWrite terminates early, but returns PV_RESULT_OK. The camera's I2C slave address (7-bits). Data being written on the I2C bus. The I2C bus speed. Default value is True for I2C's Fast mode (400 Kbits/s); false for Standard mode (100 Kbits/s). Failure can produce a containing the following result code: if the port is not initialized. if the port is not opened or the associated PvDevice is no longer connected. if not all bytes could be written to the serial port. aDevice/aPort supported I2C? Handle to PvDevice. PvIPengineSerial port true - aDevice/aPort supported I2C. false - aDevice and aPort does not support I2C. Is the device opened? true - The device is opened. false - The device is closed. Close the IP serial port connection. Failure can produce a containing one of the following result codes: if the device/port is not supported. if the device/port is invalid. Open the IP serial port to connect to the camera. Handle to PvDevice object. Serial port interface. Default is bulk interface 0 Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor. I2C serial controller. The PvDeviceI2CBus lets you send commands to your camera and receive the camera's replies. I2C uses the concept of a master and slave, where the master controls the clock and initiates reads and writes. For PvDeviceI2CBus, the video interface is the I2C master. The I2C slave is typically a camera, but could be any I2C-capable device connected to the video interface. The PvDeviceI2CBus methods manage the entire video interface and camera communication required to send a message to the camera. For example, the BurstWrite method involves the following transaction: PC calls BurstWrite. PC passes entire message to the video interface via Ethernet. BurstWrite blocks. video interface to camera: [Start condition] aSlaveAddress [Write - SDA low]. Camera to video interface: Acknowledge. video interface to camera: [First 8 bits of aBuffer]. Camera to video interface: Acknowledge. video interface to camera: [Next 8 bits of aBuffer]. Camera to video interface: Acknowledge. ... video interface to camera: [Last 8 bits of aBuffer]. Camera to video interface: Acknowledge. video interface to camera: [Stop condition]. video interface reports the successful transmission of the message to the PC (via Ethernet). BurstWrite method unblocks (returns). For the complete hardware-level transactions for all PvDeviceI2CBus methods, see your hardware guide. To send I2C-protocol serial commands to your camera: Create an I2C serial controller of the PvDeviceI2CBus class. Send a command to the camera. Use BurstWrite. Test to ensure the message send succeeded. Check the PvResult returned by BurstWrite. Retrieve the camera's reply. Use BurstRead. Test to ensure the message retrieval succeeded. Check the PvResult returned by BurstRead. Test the content of the message from the camera. Use aBuffer and aBufferSize parameters and your own code. For a simple example illustrating how to use PvDeviceI2CBus, refer to the sample entitled PvI2CSample. Device serial port. Invalid serial port Bulk7 Bulk6 Bulk5 Bulk4 Bulk3 Bulk2 Bulk1 Bulk0 Non-bulk 1 Non-bulk 0 Callback invoked after a acquisition state has changed. See delegate documentation for more information. Returns the source address. Returns the state of the acquisition. Stops the acquisition. Sends the AcquisitionStop command. Releases TLParamsLocked. Failure can produce a containing one of the following result codes: if the PvDevice is not valid or there are issues with some of the GenICam parameters. can be propagated up if issues are encountered accessing the parameters of the device GenICam interface. Starts the acquisition. Selects the right source (if applicable) Retrieves AcquisitionMode to configure the number of buffers to receive, allowing automatic unlock/stop if applicable. Issue AcquisitionStart command to the device. Failure can produce a containing one of the following result codes: if the PvDevice is not valid or there are issues with some of the GenICam parameters. if TLParamsLocked is already set. if some critical GenICam parameters not implemented in the device GenICam interface. can be propagated up if issues are encountered accessing the parameters of the device GenICam interface. Finalizer. Destructor Constructor Reference to PvDevice acquisition controller. Reference to PvStream receiving buffers. Optional. Index of the source in SourceSelector to use. Optional. Constructor Reference to PvDevice acquisition controller. Reference to PvStream receiving buffers. Optional. Constructor Reference to PvDevice acquisition controller. Acquisition state manager, advanced TLParamsLocked manager. Contains logic to manage the TLParamsLocked GenICam parameter of a PvDevice over various acquisition modes. A PvDevice is provided to the constructor of this class. A PvStream is also usually provided. The Start and Stop methods are invoked to start and stop the acquisition. If a stream is not provided, the acquisition state has to be reset manually for some acquisition mode as incoming buffers cannot be reported/counted. It takes control of issuing Start/Stop methods to the AcquisitionStart and AcquisitionStop GenICam commands of a device. It also counts frames (when applicable) to automatically release TLParamsLocked when all the buffers have been accounted for. It is possible to cancel the operation pre-emptively by calling Stop - if the user wants to cancel the operation or the user knows some buffers were lost and will never come. PvAcquisitionStateManager acquisition state changed event delegate. Reference to the device controlled by the acquisition state manager. Reference to the PvStream object. Source for which the acquisition state changed. New acquisition state. To indicate the state of the acquisition. Acquisition state is unlocked - not streaming. Acquisition state is locked - streaming. Unknown state of acquisition. Resets the history. Queries the displayed frame rate average. Used by eBUS Player in the status control that displays the display frame rate. Checks whether displaying a frame now would bring us close to the desired display frame rate or not. If the new frame will bring you closer to your desired frame rate, the method returns true and you send the frame to be displayed to a PvDisplayControl or your own display class. If it returns false, this new frame would bring you above the desired display rate. The frame can still be processed, etc. but displaying it would bring you above the desired frame rate. The expected course of action would then be to simply not display the frame and wait for a new incoming frame - instead of holding to the current one and trying to display it later. The target (desired) display frame rate. True if the frame should be displayed, false if not. Finalizer. Destructor. Constructor. Display frame rate manager. Used to stabilize the frames-per-seconds displayed. This class is pretty simple to use. Just instantiate an object and call the IsTimeToDisplay every time you have a new frame to display, specifying the desired frame rate. This class is not tied to the display. It simply keeps track of the times associated with displayed frames (IsTimeToDisplay returning true) in a circular buffer and uses this history to decide if it is time to display a new frame. This class is not part of the core of the eBUS SDK. It is provided as a utility class shared by some Pleora samples. You are welcomed to use it in your own applications if it can help. Opens a USB3 Vision stream object. GUID of the USB3 Vision device. Streaming channel to listen to. The number of buffers can be queued in the streaming object at one time. Failure can produce a containing one of the following result codes: Opens a USB3 Vision stream object. GUID of the USB3 Vision device. Streaming channel to listen to. Failure can produce a containing one of the following result codes: Opens a USB3 Vision stream object. GUID of the USB3 Vision device. Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor. Receive data from a USB3 Vision transmitter. Sets the Pleora Protocol device's IP address. This static method lets you configure the Pleora Protocol device's IP address. The Pleora Protocol device's MAC address. The Pleora Protocol device's new IP address. The Pleora Protocol device's new subnet mask. The Pleora Protocol device's new gateway. Failure can produce a containing one of the following result codes: Simply allows changing the IP configuration of a Pleora Protocol device. Saves the filter configuration to a configuration file. Configuration writer to which filter configuration is saved. Failure can produce a containing one of the following result codes: Loads the filter configuration from a configuration file. Configuration reader from which to load the filter configuration. Failure can produce a containing one of the following result codes: Light threshold for the filter. Must be between 1 and 255 and larger than the dark threshold. Dark threshold for the filter. Must be between 0 and 254 and smaller than the light threshold. Returns whether the filter is enabled. Automatically configures the minimum and maximum thresholds to the lightest and darkest pixel values in the image using the latest available histogram information available. Resets the filter. Disables the filter and resets the minimum and maximum thresholds to 0 and 255. Retrieves histogram information for the last processed image. Copies the histogram data into an array. The array must be large enough to hold 256 elements. Note: If the array is capable of holding more than 256 elements, the eBUS SDK will only fill the first 256 elements of the array. aMaxValue The highest value stored in the array. aHistogram Pointer to the array to copy the histogram data to. Failure can produce a containing one of the following result codes: Applies the range filter to an image in a buffer. If the filter is disabled, the input buffer is returned. If the filter is enabled, the range filter is applied and a pointer to the buffer containing the processed data is returned. Input image buffer. The processed buffer if enabled, the input buffer if disabled. Finalizer. Destructor. Constructor. Increases the contrast of displayed images and exported H.264 video by constraining the image to a minimum and maximum range of pixel values. Provides a histogram to analyze the dynamic range. Sets the error list where all errors/warnings are logged. The Save flushes writes all configurations in the PvConfigurationWriter object (using Store) to disk. A handle to a string list. The content of the list is not reset, new errors are simply added to the list. A contextual prefix added to all errors as they are added to the error list. Failure can produce a containing the following result code: Flush all stored configurations to a string. The Save flushes writes all configurations in the PvConfigurationWriter object (using Store) to a string. The string where to save the configuration. Failure can produce a containing the following result code: Flush all stored configurations to disk. The Save flushes writes all configurations in the PvConfigurationWriter object (using Store) to disk. The configuration file's filename and path. Failure can produce a containing the following result code: Stores a property list. Can be used to persist a property list object. A property is name/value pair. See , aDevice parameter. See . Failure can produce a containing the following result code: Stores a property list. Can be used to persist a property list object. A property is name/value pair. See , aDevice parameter Failure can produce a containing the following result code: Store a . Can be used to persist application information other than or status in a single configuration file. See , aDevice parameter. See . Failure can produce a containing the following result code: Store a . Can be used to persist application information other than or status in a single configuration file. See , aDevice parameter. Failure can produce a containing the following result code: Store a custom string. Can be used to persist application information other than or status in a single configuration file. See , aDevice parameter. See . Failure can produce a containing the following result code: Store a configuration. To use this method, see Store(PvDevice^, String). See Store(PvDevice^, String^). See Store(String^, String^). Failure can produce a containing the following result code: Store a configuration. To use this method, see Store(PvDevice^, String). See . Failure can produce a containing the following result code: Store a configuration. The Store family of methods add a configuration to the PvConfigurationWriter object. You must call to flush your configurations to disk. The Store methods use a (ConfigurationType, ConfigurationName) parameter format. The ConfigurationType is the object (, , or ); the ConfigurationName is an arbitrary identifying name for the configuration. The configuration type; the object whose information will be stored. Other Store methods have similar behavior, but different data types ( or ). The configuration name; an arbitrary identifying name for this configuration (since you set it, it may differ from the value returned by methods such as PvDeviceInfo.GetUserDefinedName). Failure can produce a containing the following result code: Store a configuration. To use this method, see Store(PvDevice^, String). Handle to configuration. Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor. Save the state of the system. You can save: The GigE Vision device's state (all parameters that can be streamed).The SDK's state (stream information and information needed to connect to a GigE Vision device).Your own custom strings and property lists.To save your state information:1. Create a configuration writer. Use .2. Store state information in the configuration writer.For GigE Vision device controllers (PvDevice objects), use Store(PvDevice, String).For GigE Vision stream channel receivers (PvStream objects), use Store(PvStream, String).3. Optionally, store your own state information. Use Store(String, String).4. Optionally, repeat the two previous steps.5. Save the stored information to disk. Use . To load your state information: see Sets the error list where all errors/warnings are logged. A handle to a string list. The content of the list is not reset, new errors are simply added to the list. A contextual prefix added to all errors as they are added to the error list. Restores a property list from its index. Index of the property list to restore from the persistence data. Handle to the property list to restore that data to. Failure can produce a containing the following result code: Restores a property list from its name. Handle to the name of the property list to restore from the persistence data. Handle to the property list to restore that data to. Failure can produce a containing the following result code: Returns the name of a property list from its index. See . Failure can produce a containing the following result code: See . Returns the number of PvPropertyList objects saved in the configuration file. Apply a configuration to a . Index of the parameter array to restore from the persistence data. Handle to the parameter array to restore the data. Failure can produce a containing the following result code: Restores a GenICam parameter array from its name. Name of the parameter array to restore from the persistence data. Handle to the parameter array to restore the data. Failure can produce a containing one of the following result codes: Returns the name of a GenICam parameter array from its index. See GetDeviceName. Failure can produce a containing the following result code: See . Returns the number of parameter array store in the configuration file. Apply a configuration. See Restore(uint32_t,PvDevice^). See Restore(uint32_t, String^). See Restore(uint32_t, PvDevice^), aDevice parameter. Failure can produce a containing the following result code: Apply a configuration. See Restore(const String^, PvDevice^). See Restore(const String^, PvDevice^). See Restore(const String^, PvDevice^), aDevice parameter. See Restore(const String^, PvDevice^). Get the custom-state string name (PvString). See GetDeviceName. See GetDeviceName. See GetDeviceName. Returns the number of custom-state strings in the configuration file. Apply a configuration to a PvStream. See Restore(uint32_t,PvDevice^). See Restore(uint32_t, PvDevice^). See Restore(uint32_t, PvDevice^), aDevice parameter. See Restore(uint32_t,PvDevice^). Apply a configuration to a PvStream. See Restore(const String^, PvDevice^). See Restore(const String^, PvDevice^). See Restore(const String^, PvDevice^), aDevice parameter. Failure can produce a containing one of the following result codes: (The stream configuration wasn't found in the file). Get the configuration name PvStream. See GetDeviceName. See GetDeviceName. Returns the number of stream configuration in this PvConfigurationReader. See GetDeviceCount. Apply a configuration to a PvDevice. The Restore methods apply a configuration loaded into a configuration reader (using the Load method) to a PvDevice. In general, the parameters for the Restore methods use a (ConfigurationIdentifier, Target) format. The ConfigurationIdentifier is the configuration's name or index number; Target is the PvDevice object, PvStream object, or custom string that receives the state. The configuration's index number. The target that receives the new configuration. The target might be a PvDevice (aDevice), a PvStream (aStream), or a custom configuration (aString). Failure can produce a containing one of the following result codes: (The device configuration wasn't in the file). Apply a configuration. This method is identical to the Restore(uint32_t, PvDevice^) family of methods, with the following exceptions: These methods identify the configuration by name (aName) rather than index number (aIndex). Name-based restore methods include: Restore(const String^, PvDevice^) Restore(const String^, PvStream^) Restore(const String^, String^) The configuration name. See Restore(uint32_t, PvDevice^). See Restore(uint32_t,PvDevice^). Get the configuration name PvDevice. The Get*Name methods let you determine the name of the configuration before calling the Restore methods. The index within the list of the devices; a value between 0 and GetDeviceCount-1. Failure can produce a containing the following result code: The configuration's name. Returns the number of PvDevice configurations available. This family of properties returns the number of configurations in a configuration file. The properties include: DeviceCount StreamCount StringCount Loads an XML (pvcfg) from a string. The Load method loads a configuration file from a string into the PvConfigurationReader object's internal memory. The configuration string. Failure can produce a containing the following result code: Loads an XML (pvcfg) file. The Load method loads a configuration file from disk into the PvConfigurationReader object's internal memory. To apply a configuration state, Use the following methods: The configuration file's name and path. Failure can produce a containing the following result code: Finalizer. Destructor. Constructor. Restore the state of the system. To load your GigE Vision device controller (PvDevice object) or stream controller (PvStream object) state from disk: 1. Create a configuration reader. 2. Load the file from disk. Use . 3. Returns the number of configurations. Use the following properties: 4. Optionally, test for the name of a configuration. Use the following methods: 5. Apply a configuration to an object. Use the following methods: Note:If the GigE Vision device controller (PvDevice object) isn't connected to the GigE Vision device, it attempts to connect (as if calling PvDevice.Connect). If already connected, the settings are applied without changing the IP address and related information. The same applies to a PvStream that is already opened. The property value. The property name. Destructor. Constructor that can set name, value. Property name. Property value. Default constructor. Simple name/value string pair class. Connect to a USB3 Vision device. The method connects to a USB3 Vision device found using a or PvDeviceFinderWnd object. Only one device can be connected to at a time. The USB3 Vision device's connectivity information; a object. Failure can produce a containing one of the following result codes: Finalizer. Destructor Constructor Connect, configure and control a USB3 Vision device Returns the transfer progress. How many bytes have been transferred. Size of the transfer in bytes. Failure can produce a containing one of the following result codes: If no transfer is in progress Returns the last error message. Can be one of: The transfer completed successfully The transfer is still in progress The transfer failed. The description of the result should contain more information The transfer was aborted Pops the oldest transfer warning and returns it in a string. Returns warnings string. Aborts the current transfer. As the send and receive methods are blocking, this one needs to be called from a different thread. Failure can produce a containing one of the following result codes: If no transfer is in progress Gets data from a device file using TFTP. Pointer to the buffer where the data is written. The size of the buffer in bytes. Output, the number of bytes read from the device file into aBuffer in bytes. Failure can produce a containing one of the following result codes: If the buffer parameters are invalidIf a transfer is already in progressIf Init has not been called Reads a file from the device using TFTP. The file read from the device is written to that location. Failure can produce a containing one of the following result codes: If the file does not exist or cannot be openedIf a transfer is already in progressIf Init has not been called Reads a file from the device using TFTP. aDeviceFilename (from Init) from the current working directory is sent to the device. Failure can produce a containing one of the following result codes: If the file does not exist or cannot be openedIf a transfer is already in progressIf Init has not been called Sends data to a device file using TFTP. Pointer to the buffer containing the data to send. The size of the buffer, in bytes. Failure can produce a containing one of the following result codes: If the buffer parameters are invalidIf a transfer is already in progressIf Init has not been called Sends a local file to the device using TFTP. The name of the local file to write to the device. Failure can produce a containing one of the following result codes: If the file does not exist or cannot be openedIf a transfer is already in progressIf Init has not been called Sends a local file to the device using TFTP. aDeviceFilename (from Init) from the current working directory is sent to the device. Failure can produce a containing one of the following result codes: If the file does not exist or cannot be openedIf a transfer is already in progressIf Init has not been called Initializes the client for file transfer. The IP address of the device to transfer to/from. The name device-side filename written to or read from the device. Failure can produce a containing one of the following result codes: If the IP address is invalid Finalizer. Destructor. Constructor Sends or receives files from a GigE Vision device using the TFTP protocol. Changes the value of an string parameter. The name of the parameter to change. The new value of the parameter. Failure can produce a containing one of the following result codes: (Use to get more information). if the parameter does not exist Changes the value of an Boolean parameter. The name of the parameter to change. The new value of the parameter. Failure can produce a containing one of the following result codes: (Use to get more information). if the parameter does not exist Changes the value of an enum parameter. The name of the parameter to change. The new integer value of the parameter. Failure can produce a containing one of the following result codes: (Use to get more information). if the parameter does not exist Changes the value of an enum parameter. The name of the parameter to change. The new symbolic (string) value of the parameter. Failure can produce a containing one of the following result codes: (Use to get more information). if the parameter does not exist Changes the value of an float parameter. The name of the parameter to change. The new value of the parameter. Failure can produce a containing one of the following result codes: (Use to get more information). if the parameter does not exist Changes the value of an integer parameter. The name of the parameter to change. The new value of the parameter. Failure can produce a containing one of the following result codes: (Use to get more information). if the parameter does not exist Finalizer. Destructor. Constructor The GenICam parameter array to operate on. Performs changes to a GenICam node map, tracks them and restores the previous state on destruction. This class can be used to make temporary changes to a GenICam node map. Every parameter changed through this class is tracked and its original value is saved. When the object is destroyed, the original value of all parameters is restored in the reverse order. This class is very useful when dealing with selectors. If you want to change a selected value without affecting the current selector state of the node map, create an object of this type, change the selector(s) using the Set methods, perform your changes and let the object go out of scope: the selectors will go back to their original values. Assume A is originally 1, B is 2, C is 3. If you use this class to change A 4, B to 5 and C to 6 (in that order) when the object goes out of scope C will be set back to 3, B to 2 and A to 1 (in that order as well). If a value cannot be set (an error occurs) the previous value is not pushed on the stack of parameters that will be restored when the destructor is called. If the parameter is already set to the requested value, its value IS NOT changed, and IS NOT pushed on the stack to be eventually restored. This is done to minimize traffic to the device and to avoid having too many invalidators to be fired when a selector is already set to the right value. Resets the statistics counters of the action command object. Returns the count of status No Ref Count acknowledgements received since the object was created or the last time was called. Returns the count of status overflow acknowledgements received since the object was created or the last time was called. Returns the count of status late acknowledgements received since the object was created or the last time was called. Returns the count of status OK acknowledgements received since the object was created or the last time was called. Returns the Status from which the acknowledgement at aIndex from the last Send was sent from. Zero-based network interface index. See . The Status from which the acknowledgement at aIndex from the last Send was sent from. Failure can produce a containing one of the following result codes: Returns the IP address from which the acknowledgement at aIndex from the last Send was sent from. Zero-based network interface index. See . The IP address from which the acknowledgement at aIndex from the last Send was sent from. Failure can produce a containing one of the following result codes: Returns how many acknowledgements have been received following the last / If / did not ask for acknowledgements this method simply returns 0. Any acknowledgements received after the method aTimeout are not counted. Resends the action command using the same request ID. An application receiving an action command with the same request ID will acknowledge it but not execute the action if it was previously received. Resends are not managed automatically as all application may have different requirements when it comes to resending actions. They need to be explicitly managed and performed if acknowledgements are missing. Maximum time to wait for answers in ms. If different than zero, Send can return as soon as aDeviceCount acknowledgements have been received without having to wait for aTimeout. Sets the request acknowledgement bit of the action commmand, instructing the devices to acknowledge the command. If the provided timeout expired before the reception of all the acknowledgements If the command was never sent before calling Resend If the content of the command has changed since the last Send operation. A resend cannot be performed if the command is not exactly the same. Resends the action command using the same request ID. An application receiving an action command with the same request ID will acknowledge it but not execute the action if it was previously received. Resends are not managed automatically as all application may have different requirements when it comes to resending actions. They need to be explicitly managed and performed if acknowledgements are missing. Maximum time to wait for answers in ms. If different than zero, Send can return as soon as aDeviceCount acknowledgements have been received without having to wait for aTimeout. If the provided timeout expired before the reception of all acknowledgements. If the command was never sent before calling Resend. If the content of the command has changed since the last Send operation. A resend cannot be performed if the command is not exactly the same. Resends the action command using the same request ID. An application receiving an action command with the same request ID will acknowledge it but not execute the action if it was previously received. Resends are not managed automatically as all application may have different requirements when it comes to resending actions. They need to be explicitly managed and performed if acknowledgements are missing. Time to wait for answers in ms. If the command was never sent before calling Resend If the content of the command has changed since the last Send operation. A resend cannot be performed if the command is not exactly the same. Broadcasts the action command on all enabled network interfaces. If more than one network interface is enabled, broadcasts are sent on each network interface (one after the other, in the order they were added to the action command object) and do not wait for any acknowledgements. When Send is used, the request ID of the action command is automatically incremented. Use to send the same action without incrementing the request ID. The action command itself does not know how many devices are reached with this broadcast: all devices receiving the action command and configured to react to it (combination of device key, group key and group mask) are expected to perform the task associated with it. Maximum time to wait for answers in ms. If different than zero, Send can return as soon as aDeviceCount acknowledgements have been received without having to wait for aTimeout. Sets the request acknowledgement bit of the action commmand, instructing the devices to acknowledge the command. If the provided timeout expired before the reception of all acknowledgements. Broadcasts the action command on all enabled network interfaces. If more than one network interface is enabled, broadcasts are sent on each network interface (one after the other, in the order they were added to the action command object) and waits for acknowledgements. When Send is used, the request ID of the action command is automatically incremented. Use to send the same action without incrementing the request ID. When using this overload of the Send function, acknowledgements are asked from the device. The action command itself does not know how many devices are reached with this broadcast: all devices receiving the action command and configured to react to it (combination of device key, group key and group mask) are expected to perform the task associated with it. Maximum time to wait for answers in ms. If different than zero, Send can return as soon as aDeviceCount acknowledgements have been received without having to wait for aTimeout. If the provided timeout expired before the reception of all the acknowledgements. Broadcasts the action command on all enabled network interfaces. If more than one network interface is enabled, broadcasts are sent on each network interface (one after the other, in the order they were added to the action command object) and do not wait for any acknowledgement. When Send is used, the request ID of the action command is automatically incremented. Use to send the same action without incrementing the request ID. When using this overload of the Send function, acknowledgements are asked from the device. The action command itself does not know how many devices are reached with this broadcast: all devices receiving the action command and configured to react to it (combination of device key, group key and group mask) are expected to perform the task associated with it. Time to wait for answers in ms. Gets and sets current action command scheduled time. Action commands can either be performed on reception (no scheduled time enabled and provided) or they can be scheduled in the future. If a timestamp (device time domain) is provided the device queues the action command and performs the task associated to it as close to the scheduled action command timestamp as possible. If the device receives a timestamp set in the past relative to its time domain, it is expected to execute the command on reception. The queue the device uses to hold future actions may be limited. If a new command is received and the device is not able to add it to a full queue the sender is notified as long as acknowledgements of the action command has been requested. The schedule time will only be used when the schedule time is enabled. Gets and sets current action command scheduled time enabling state. Action commands can either be performed on reception (no scheduled time enabled and provided) or they can be scheduled in the future. This function allow the control over the enabling state of the schedule action command. Gets and sets current action command group mask A group mask can be configured on an action command. This mask is applied by the device against the group mask of the action command and if the resulting value is non-zero the action is executed by the device. The group mask attribute allows defining groups and dynamically select a subset of devices to execute a specific command without having to alter the group key of the devices. The group mask for actions of a device would typically be configured using the GenICam interface of the device. The group mask is defined at the action level: different actions on a device can have different group masks. Gets and sets current action command group key The group key defines a group of devices on which actions have to be executed. If a device supports action 1 with a group key of 0x24 and action 2 with a group key of 0x42 and an action command with group key of 0x24 is sent only action 1 is executed. The group key for actions of a device would typically be configured using the GenICam interface of the device. The group key is defined at the action level: different actions on a device can have a different group keys. Gets and sets current action command device key The device key is a 32 bit value used to check the validity of action commands. Devices are only processing action commands if their device key matches the device key configured on the device – think of it as a secret password provided by action commands that must match the password configured on the device. The device key on the device would typically be configured using the GenICam interface of the device. The device key is defined at the device level. Enables or disables sending the action command on the network interface at aIndex. If a network interface is selected to send commands and it is not active (0.0.0.0 IP address) the command is not sent on the network but the operation does not fail either. Zero-based network interface index. See . true to enable sending the action command on the network interface at aIndex, false to disable it. Failure can produce a containing one of the following result codes: Gets whether action commands are sent or not on the network interface at aIndex. Zero-based network interface index. See . Failure can produce a containing one of the following result codes: Whether action commands are sent or not on the network interface at aIndex. Returns a string containing the description of the network interface at aIndex. This string is provided by the operating system. Zero-based network interface index. See . Failure can produce a containing one of the following result codes: A string containing the description of the network interface at aIndex. Returns a string containing the IP address of the network interface at aIndex. Zero-based network interface index. See . Failure can produce a containing one of the following result codes: A string containing the IP address of the network interface at aIndex. Returns a string containing the MAC address of the network interface at aIndex. Zero-based network interface index. See . Failure can produce a containing one of the following result codes: A string containing the MAC address of the network interface at aIndex. Returns the number of network interfaces available on the system. Finalizer. Destructor Constructor. Utility class to send action command PvActionCommand add the ability of firing action commands defined using the GigE Vision action commands model. To use a PvActionCommand, you instantiate an object from the class, configure the command to send, send the command and then optionally retrieve statistics about the outcome of the command. It is possible to use the same action command object to send more than one command: the same by calling Send over and over or different commands by changing its configuration between Send calls. The eBUS SDK does not take charge of configuring action commands on the device directly. We assume that the GenICam interface of the device allows that and the user is either doing it manually with the GenICam browser in eBUS Player or programmatically in its own application. Action command acknowledges type. The device is not synchronized to a master time clock to be used as time reference. The device action command queue is full and cannot take the additional action command. The requested schedules action command was requested in a time that is already past. Success Used to retrieve string-based operation of the last operation on a PvGenFile. Use this method to retrieve detailed information about the last failed operation that throws GENERIC_ERROR exception. EOFs and other status are not considered errors and are monitored through the GetStatus method. Error message associated with the last operation on a PvGenFile. Returns all available files for a GenICam interface. Handle to List of strings that will contain all the available files after the method returns Returns true if a file defined by the GenICam interface can be written. Handle to Pass a file to be written. True if the false is writable, false if not. Returns true if a file defined by the GenICam interface can be read. Handle to Pass a file to be read. True if the false is readable, false if not. Static method used to query if a PvGenParameterArray supports file access. A PvGenParameterArray must support the following features in order to allow access to device files through GenICam: PvGenEnum.FileSelector PvGenEnum.FileOperationSelector (must contain "Open", "Close", "Read", "Write" operations) PvGenEnum.FileOpenMode (must contain "Read", "Write") PvGenInteger.FileAccessOffset PvGenInteger.FileAccessLength PvGenRegister.FileAccessBuffer PvGenEnum.FileOperationStatus (must contain "Success" enum entry) PvGenCommand.FileOperationExecute PvGenInteger.FileOperationResult Handle to True if supported, false if not. Returns progress about the current read or write operation. How many bytes have been read or written. Total byte count for the read or write operation. Failure can produce a containing one of the following result codes: (Use to get more information). if no read or write operation is in progress or completed. Gets the status of the last operation on a PvGenFile. Last status of a read or write operation as provided by the device. The only enum entry guaranteed to be provided by all devices is "Success" and everything else is quality of implementation. As an example, the reference GenApi implementation for files assumes end-of-file (EOF) if anything else other than "Success" is reported after a read or a write. Open, Close, Read and Write operations can get the status through GetStatus. The GetStatus shows the success or failure (or EOF) of the operation on the device. Failure can produce a containing one of the following result codes: (Use to get more information). if the file is not opened. Reads data from the opened device file. Reads aLength bytes from the device file into aBuffer. If EOF (end-of-file) is reached, aBytesRead is 0 or less than aLength. Pointer to the data to write to the device file. Number of bytes to write to the device file. Number of bytes successfully read from the device file. Failure can produce a containing one of the following result codes: (Use to get more information). if the file is not opened. Writes data to the opened device file. Writes aLength bytes from aBuffer to the device file. If EOF (end-of-file) is reached, aBytesWritten is 0 or less than aLength. Pointer to the data to write to the device file. Number of bytes to write to the device file. Number of bytes successfully written to the device file. Failure can produce a containing one of the following result codes: (Use to get more information). if the file is already opened. Reads a complete device file and writes it to a local file. The full path of the local file where data read from the device file is written to. Failure can produce a containing one of the following result codes: (Use to get more information). if the file is already opened. if the local file cannot be opened. Writes a complete local file to the opened device file. The full path of the local file to write to the device file. Failure can produce a containing one of the following result codes: to get more information). if the file is already opened. if the local file cannot be opened.ERR_OVERFLOW if EOF was reached on the device file before the complete local file could be written. If the file object is opened or not. True if it is opened and attached to a PvGenParameterArray, false if not. Closes the PvGenFile. Closes the PvGenFile, detaches the PvGenParameterArray. Failure can produce a containing one of the following result codes: (Use to get more information). if the file is already opened.FILE_ERROR if the GenICam file close operation fails. Opens a file through the GenICam interface. Attaches the PvGenFile object to a GenICam parameter array, validates the filename exists for this device and perform the open operation through GenApi. The GenICam parameter array to use. The filename of the file to open on the device. Must match one of the pre-defined enumeration entry of the FileSelector feature. The filename is case sensitive. Mode used to access the file. Read or write. Failure can produce a containing one of the following result codes: (Use to get more information). if the file is already opened. if the file does not exist. if aMode is not one of the supported open modes.FILE_ERROR if the GenICam file open operation fails. if the does not have all expected features to support files. Finalizer. Destructor. Constructor Allows reading/writing to files hosted on the device. These files could be debug information, look-up tables, new firmware, configuration files, persistent configurations or just about anything. Mode used to access the file. Undefined access mode. Read access mode. Write access mode. Returns the XML ID used to build the node map. XML ID or an empty string if Build has not happened or failed. Returns the Device ID used to connect the port. Device ID or an empty string if Connect has not happened or failed. Returns the Port ID used to connect the port. Port ID or an empty string if Connect has not happened or failed. Gets the serial timeout used by the CLProtocol library. New timeout. Failure can produce a containing one of the following result codes: if the PvGenParameterArrayCL is not connected. . if building the node map failed. Use for more information. Sets the serial timeout used by the CLProtocol library. New timeout. Failure can produce a containing one of the following result codes: if the PvGenParameterArrayCL is not connected. . if building the node map failed. Use for more information. Builds the node map. Using the specific XML from the subset returned by GetXMLIDs, builds the node map thus completing the PvGenParameterArrayCL. After a successful call to this method, the PvGenParameterArrayCL is ready to use. XML ID as returned by . Failure can produce a containing the following result code: if building the node map failed. Use for more information. Returns all XMLs that can be used to build the node map behind the PvGenParameterArrayCL. Fails if the PvGenParameterArrayCL is not connected. The strings returned are properly formatted and ready to be used in a GUI. String list of available XML. Failure can produce a containing the following result code: if the operation fails. Use PvResult.Description for more information. Using a valid device ID, connects the empty PvGenParameterArrayCL to a camera through a specific port. After calling this method, the port and camera are connected but the node map has not yet been created yet. Port to use when probing the device. Available ports are enumerated with GetPortIDs. With the eBUS SDK the enumerated ports are highly likely going to be named PvSerialBridge used in Camera Link DLL mode. Can be resolved from a template with ProbeDevice or simply be known from a previous session with the same system configuration. Failure can produce a containing the following result code: if the operation fails. Use PvResult.Description for more information. Using a device template, a specific port is probed for a camera. If a camera is found a camera ID is returned to the caller. That camera ID can be used to connect to camera. Port to use when probing the device. Available ports are enumerated with GetPortIDs. With the eBUS SDK the enumerated ports are highly likely going to be named PvSerialBridge used in Camera Link DLL mode. Allows selecting which CLProtocol library to use and can even refine the camera selection within the library. All possible device templates for the system can be enumerated with GetDeviceTemplates. Optional serial timeout used when probing the camera. 500 milliseconds is used as a default value if not provided. Camera ID, if a camera is found. Using a device template, a specific port is probed for a camera. This overload method ProbeDevice has one default argument parameters, for information about the default argument parameter UInt32 aSerialTimeout of this overload method, refer to the other overload method . If a camera is found a camera ID is returned to the caller. That camera ID can be used to connect to camera. Port to use when probing the device. Available ports are enumerated with GetPortIDs. With the eBUS SDK the enumerated ports are highly likely going to be named PvSerialBridge used in Camera Link DLL mode. Allows selecting which CLProtocol library to use and can even refine the camera selection within the library. All possible device templates for the system can be enumerated with GetDeviceTemplates. Camera ID, if a camera is found. Static method returning the list of all available device templates. A device template is used as a hint when probing cameras on a specific port. The device template list is built from all available CLProtocol.dll on the system. One DLL can support more than one device template. The strings returned are properly formatted and ready to be used in a GUI. aDeviceTemplateList String list containing available device templates. Static method returning the list of all available port IDs. The list is built from the list of Camera Link DLLs available on the system. The strings returned are properly formatted and ready to be used in a GUI. aPortIDList List of strings representing available ports. Finalizer. Destructor. Constructor. Camera Link CLProtocol GenICam feature array. Test if the specified GigE Vision device is currently reachable through an eBUS driver The GigE Vision transmitter's IP address. Local IP address the device will be streaming to. Optional, can improve IsDriverInstalled method performance. True if the device is reachable through an eBUS driver; otherwise, false. Failure can produce a containing one of the following result codes: Test if the specified GigE Vision device is currently reachable through an eBUS driver The GigE Vision transmitter's IP address. True if the device is reachable through an eBUS driver; otherwise, false. Failure can produce a containing one of the following result codes: Set / Get the priority of the thread used to run the data receiver user mode Only applicable if using a user-mode data receiver. The thread priority of a driver-based data receiver cannot be controlled. This thread receives and processes all packets received from the device. If you change the thread priorities, it may alternate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities. Get the stream's MulticastIPAddress property. Get the stream's LocalIPAddress property. Get the stream's DataPort property. Flushes all non-processed UDP packets from the data receiver. Should be called before resuming streaming after a pause to ensure that old packets are not processed as new incoming data. The following PvException result code will be produced: OK Flushes all non-processed UDP packets from the data receiver. Should be called before resuming streaming after a pause to ensure that old packets are not processed as new incoming data. The following PvException result code will be produced: OK Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter. Note that this overload of Open is for receiving blocks that are multicasted from a GigE Vision transmitter to a given multicast group. To receive unicasted data, refer to the other group of overloads of the Open method. Multicasting is the delivery of data to a group of receivers simultaneously in a single transmission. The following example illustrates how to multicast data from one transmitter to a given set of receivers: Connect receivers and transmitter to an IGMP compliant switch.The GigE Vision transmitter begins transmitting to a multicast group (i.e. 239.192.1.1:1042).The GigE Vision transmitter has a control channel listening for device discovery requests and packet resend requests on a given IP address (i.e. 169.254.1.1).Receiver applications discover the device and subscribe to the multicast group (call Open( "169.254.1.1", "239.192.1.1", 1042 )) Why does the GigE Vision device address (aIPAddress) need to be specified? In this example, the data is transmitted using the GVSP protocol to a multicast group (239.192.1.1:1042). The receiving application contacts the device (IP address 169.254.1.1) using the GVCP protocol to ensure that it is reachable. In addition to this, packet resend requests are directed from receiver to GigE Vision device using the GVCP control channel. This is by design as per the GigEVision standard. Multicasting uses the IGMP (Internet Group Management Protocol) and requires an IGMP-compliant switch. The switch maintains a list of subscribed peers associated with a given multicast group. Multicast group IP addresses take the form 239.192.xx.yy. It is also possible to use multicasting with a non-IGMP compliant switch or network. In that case, the multicast stream is simply broadcasted to every connected entity on the network. It can be OK in controlled environment, but use with caution! To learn more about IGMPv3, see RFC 3376 at www.ietf.org. For a complete illustration of how to use this method to receive data multicasted from a GigE Vision transmitter, refer to the following two samples: MulticastMaster - Connects to a GigE Vision device as a controler and tells it to begin streaming to a multicast address.MulticastSlave - Illustrates the use of multicast version of Open by receiving the data the GigE Vision device is transmitting. The GigE Vision transmitter's IP address. The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling PvDevice::SetStreamDestination.) The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling PvDevice::SetStreamDestination.) The GigE Vision transmitter's streaming channel (default 0). The local IP address upon which to begin receiving incoming data. An empty string (default) indicates that the local IP address will be assigned automatically. Call #GetLocalIPAddress afterwards to obtain the local IP address that was assigned by the system. Set the streaming channel port number (SCP) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination. The maximum number of buffers that can be stored simultaneously in the data receiver. Failure can produce a containing one of the following result codes: Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter. Note that this overload of Open is for receiving blocks that are multicasted from a GigE Vision transmitter to a given multicast group. To receive unicasted data, refer to the other group of overloads of the Open method. Multicasting is the delivery of data to a group of receivers simultaneously in a single transmission. The following example illustrates how to multicast data from one transmitter to a given set of receivers: Connect receivers and transmitter to an IGMP compliant switch.The GigE Vision transmitter begins transmitting to a multicast group (i.e. 239.192.1.1:1042).The GigE Vision transmitter has a control channel listening for device discovery requests and packet resend requests on a given IP address (i.e. 169.254.1.1).Receiver applications discover the device and subscribe to the multicast group (call Open( "169.254.1.1", "239.192.1.1", 1042 )) Why does the GigE Vision device address (aIPAddress) need to be specified? In this example, the data is transmitted using the GVSP protocol to a multicast group (239.192.1.1:1042). The receiving application contacts the device (IP address 169.254.1.1) using the GVCP protocol to ensure that it is reachable. In addition to this, packet resend requests are directed from receiver to GigE Vision device using the GVCP control channel. This is by design as per the GigEVision standard. Multicasting uses the IGMP (Internet Group Management Protocol) and requires an IGMP-compliant switch. The switch maintains a list of subscribed peers associated with a given multicast group. Multicast group IP addresses take the form 239.192.xx.yy. It is also possible to use multicasting with a non-IGMP compliant switch or network. In that case, the multicast stream is simply broadcasted to every connected entity on the network. It can be OK in controlled environment, but use with caution! To learn more about IGMPv3, see RFC 3376 at www.ietf.org. For a complete illustration of how to use this method to receive data multicasted from a GigE Vision transmitter, refer to the following two samples: MulticastMaster - Connects to a GigE Vision device as a controler and tells it to begin streaming to a multicast address.MulticastSlave - Illustrates the use of multicast version of Open by receiving the data the GigE Vision device is transmitting. The GigE Vision transmitter's IP address. The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination.) The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination.) The GigE Vision transmitter's streaming channel (default 0). The local IP address upon which to begin receiving incoming data. An empty string (default) indicates that the local IP address will be assigned automatically. Call #GetLocalIPAddress afterwards to obtain the local IP address that was assigned by the system. Set the streaming channel port number (SCP) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination. Failure can produce a containing one of the following result codes: Begin receiving blocks (images or raw data) multicasted from a GigE Vision transmitter. Note that this overload of Open is for receiving blocks that are multicasted from a GigE Vision transmitter to a given multicast group. To receive unicasted data, refer to the other group of overloads of the Open method. Multicasting is the delivery of data to a group of receivers simultaneously in a single transmission. The following example illustrates how to multicast data from one transmitter to a given set of receivers: Connect receivers and transmitter to an IGMP compliant switch.The GigE Vision transmitter begins transmitting to a multicast group (i.e. 239.192.1.1:1042).The GigE Vision transmitter has a control channel listening for device discovery requests and packet resend requests on a given IP address (i.e. 169.254.1.1).Receiver applications discover the device and subscribe to the multicast group (call Open( "169.254.1.1", "239.192.1.1", 1042 )) Why does the GigE Vision device address (aIPAddress) need to be specified? In this example, the data is transmitted using the GVSP protocol to a multicast group (239.192.1.1:1042). The receiving application contacts the device (IP address 169.254.1.1) using the GVCP protocol to ensure that it is reachable. In addition to this, packet resend requests are directed from receiver to GigE Vision device using the GVCP control channel. This is by design as per the GigEVision standard. Multicasting uses the IGMP (Internet Group Management Protocol) and requires an IGMP-compliant switch. The switch maintains a list of subscribed peers associated with a given multicast group. Multicast group IP addresses take the form 239.192.xx.yy. It is also possible to use multicasting with a non-IGMP compliant switch or network. In that case, the multicast stream is simply broadcasted to every connected entity on the network. It can be OK in controlled environment, but use with caution! To learn more about IGMPv3, see RFC 3376 at www.ietf.org. For a complete illustration of how to use this method to receive data multicasted from a GigE Vision transmitter, refer to the following two samples: MulticastMaster - Connects to a GigE Vision device as a controler and tells it to begin streaming to a multicast address.MulticastSlave - Illustrates the use of multicast version of Open by receiving the data the GigE Vision device is transmitting. The GigE Vision transmitter's IP address. The multicast IP address to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination.) The multicast port to which the receiver subscribes and the GigE Vision transmitter sends data. (Set the streaming channel port (SCP) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination.) Failure can produce a containing one of the following result codes: Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter. Note that this overload of Open is for receiving blocks that are unicasted from a GigE Vision transmitter to an interface on the same subnet. To receive multicasted data, refer to the other group of overloads of the Open method. The GigE Vision transmitter's IP address. The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination. The GigE Vision transmitter's streaming channel (default 0). The local IP address upon which to begin receiving incoming data. An empty string (default) indicates that the local IP address will be assigned automatically. Call GetLocalIPAddress afterwards to obtain the local IP address that was assigned by the system. Set the streaming channel port number (SCP) on your GigE Vision transmitter accordingly by calling PvDevice.StreamDestination. Failure can produce a containing one of the following result codes: Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter. Note that this overload of Open is for receiving blocks that are unicasted from a GigE Vision transmitter to an interface on the same subnet. To receive multicasted data, refer to the other group of overloads of the Open method. The GigE Vision transmitter's IP address. The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling PvDevice::SetStreamDestination. The GigE Vision transmitter's streaming channel (default 0). Failure can produce a containing one of the following result codes: Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter. Note that this overload of Open is for receiving blocks that are unicasted from a GigE Vision transmitter to an interface on the same subnet. To receive multicasted data, refer to the other group of overloads of the Open method. The GigE Vision transmitter's IP address. The local port upon which to begin receiving incoming data. A value of 0 (default) indicates that the local port will be assigned automatically. Call GetLocalPort afterwards to obtain the port number that was assigned by the system. Set the streaming channel destination address (SCDA) on your GigE Vision transmitter accordingly by calling PvDevice.SetStreamDestination. Failure can produce a containing one of the following result codes: Begin receiving blocks (images or raw data) unicasted from a GigE Vision transmitter. Note that this overload of Open is for receiving blocks that are unicasted from a GigE Vision transmitter to an interface on the same subnet. To receive multicasted data, refer to the other group of overloads of the Open method. The GigE Vision transmitter's IP address. Failure can produce a containing one of the following result codes: Finalizer. Destructor. Constructor. Receive data from a GigE Vision. This provides a means of opening a connection to the data receiver and obtaining data from it. Get the parameters defining how data is received from a GigE Vision transmitter. The parameters defining how data is received from a GigE Vision transmitter. Test if the stream is open. True if the method has been called (without a subsequent call); otherwise, false. Get the stream's Channel property. The stream's Channel property. Attempt to retrieve a queued buffer. To use this method, see also QueueBuffer. The RetrieveBuffer method blocks until one of the following occurs: The buffer is filled with a block (image or raw data). The retrieve buffer operation times out: it exceeds aTimeout. The acquisition fails (by being aborted, data receiver timeout as defined by ImageTimeout property, etc.) Once the method returns, you can determine the ultimate success of the image acquisition by testing the aOperationResult parameter. For example, RetrieveBuffer may return PvResult::Code::OK, even if the operation was aborted by a call to AbortQueuedBuffers or Close. In this case, aOperationResult would be PvResult::Code::ABORTED. The return value contains the RetrieveBuffer operation results and aOperationResult contains the actual result (or failure) of the data receiver on this buffer. This method can succeed in providing you the oldest buffer but the result of the operation may still be a failure - if acquisition was aborted, incomplete, etc. The buffer that holds the image. A pointer to the result of the acquisition operation on aBuffer, see PvBuffer::GetOperationResult. The buffer has been properly queued. The buffer could not be queued. See PvResult::GetDescription for more information. The stream is not connected to a transmitter. No buffers queued. Attempt to retrieve a queued buffer. To use this method, see also QueueBuffer. The RetrieveBuffer method blocks until one of the following occurs: The buffer is filled with a block (image or raw data). The retrieve buffer operation times out: it exceeds aTimeout. The acquisition fails (by being aborted, data receiver timeout as defined by ImageTimeout property, etc.) Once the method returns, you can determine the ultimate success of the image acquisition by testing the aOperationResult parameter. For example, RetrieveBuffer may return PvResult::Code::OK, even if the operation was aborted by a call to AbortQueuedBuffers or Close. In this case, aOperationResult would be PvResult::Code::ABORTED. The return value contains the RetrieveBuffer operation results and aOperationResult contains the actual result (or failure) of the data receiver on this buffer. This method can succeed in providing you the oldest buffer but the result of the operation may still be a failure - if acquisition was aborted, incomplete, etc. The buffer that holds the image. A pointer to the result of the acquisition operation on aBuffer, see PvBuffer::GetOperationResult. The maximum time, in ms, to wait for a buffer to be returned by the data receiver. The buffer has been properly queued. The buffer could not be queued. See PvResult::GetDescription for more information. The stream is not connected to a transmitter. No buffers queued. Queue a buffer to receive a block. The method queues in a buffer ( object) to a stream ( object) so it can be filled by the data receiver. For each buffer you remove (using RetrieveBuffer), you should queue another (using ). The maximum number of buffers that can be queued at a given time can be obtained by calling . To reduce the risk of missing incoming data, it is recommended that several blocks remain queued and ready to go at any given time. Generally it is recommended that a larger number of buffers remain queued for higher frame rates. Larger block sizes with blocks being streamed at a lower frame rate can afford to allocate fewer buffers to optimize memory usage and reduce potential latency. Once the stream fills the buffer with a block, retrieve the buffer by calling RetrieveBuffer. A handle to the buffer to be filled. The buffer has been properly queued. The buffer could not be queued. See PvResult::GetDescription for more information Abort all pending block requests. Once you have aborted pending block requests, they still need to be de-queued. Use RetrieveBuffer. The following PvException result code will be produced: NOT_CONNECTED Close the stream channel receiver. The following PvException result code will be produced: NOT_CONNECTED Dynamically allocates a PvStream of the right type. This static method takes a string and creates the right type of PvStream (PvStreamGEV or PvStreamU3V) and connects it. Objects allocated with CreateAndOpen should be freed with PvStream::Free. Information that uniquely identifies the device. You may use one of the following: GigE Vision device's IP Address. Use the form 192.168.1.114. USB3 Vision GUID. A pointer to the new object on success, NULL on failure. Failure can produce a containing one of the following result codes: Returns whether the object is a GigE Vision or USB3 Vision stream receiver. Specific object type. Get the maximum number of buffers ( objects) that can be queued at a time. Maximum number of buffers ( objects). Get the number of buffers ( objects) waiting to be filled with images by the data receiver. Every call to increases the count by one; every call to RetrieveBuffer reduces the count by one. The number of buffers ( objects). Finalizer. Destructor. Receives data from a GigE Vision or USB3 Vision transmitter. This provides a means of opening a connection to the data receiver and obtaining data from it. Stream type. U3V stream type. GEV stream type. Unknown stream type. Destructor. Constructor. Gets the Speed of the USB host controller. Even if a USB host controller supports super speed it does not guarantee a device will be connected as super speed. Bad cables or hubs not supporting super speed could force the controller and device to end up being connected at a slower speed. Gets the Revision of the USB host controller. Gets the Subsystem ID of the USB host controller. Gets the Device ID of the USB host controller. Gets the Vendor ID of the USB host controller. Represents one USB host controller on a system (the PC). To use this class, see #PvSystem. Destructor. Constructor. Returns true if the Pleora driver is installed on this network interface. Gets the operating system provided description of the network adapter. Gets the NIC's default gateway. Gets the NIC's subnet mask. The form follows that of . Gets the NIC's IP address. The NIC's IP address. The form is #.#.#.#, where # is 0-255. Gets the NIC's MAC address. The NIC's MAC address. The form is ##.##.##.##.##.##, where # is a 0-9 or A-F. Represents one Ethernet network adapter on a system (the PC). To use this class, see #PvSystem. Returns true if the currently selected driver for the device is the Pleora driver. Power consumption of the device in milliamp. Returns the currently effective connection speed of the USB3 Vision device. If a device supporting super speed is connected in a slower hub or controller it is not able to negotiate up to its maximum supported speed. If a device IsSuperSpeedSupported returns true and GetSpeed returns something slower look into the supported speed of the hubs chain to the controller or the controller itself. Returns true if the device supports USB3 speed. Returns true if the device supports USB2 speed. Returns true if the device supports USB1.1 speed. Returns true if the device supports USB1.0 speed. Returns the USB 3 Vision serial number of the device. Returns the family name of the device. Get the USB3 Vision GUID of the device. GUID stands for "Globally Unique Identifier". It is the USB3 Vision counterpart of the MAC of a GigE Vision device. Get the USB3 Vision device's USB3 Vision protocol version. The high 16 bits contain the major version and The low 16 bits the minor version. Get the USB3 Vision device's GenCP protocol version. The high 16 bits contain the major version and The low 16 bits the minor version. Information about a USB3 Vision device. USB speed. USB super speed. USB high speed. USB full speed. USB low speed. Unknown USB speed. Returns the enumeration status of the USB device. Current enumeration status. Information about a generic USB device. USB device status. Resets USB device. USB device is enumerating. USB device is in legacy hub. USB hub is nested too deeply. USB device does not have enough bandwidth. USB device does not have enough power. USB device is caused over current. USB device general failure. USB device failed to enumerate. USB device is connected. USB device is not initialized. Destructor. Constructor. Get the Minor version of the firmware running on the Pleora Protocol device. Get the Major version of the firmware running on the Pleora Protocol device. Get the Vendor ID of the Pleora Protocol device. Get the Sub ID of the Pleora Protocol device. Get the Module ID of the Pleora Protocol device. Get the Device ID of the Pleora Protocol device. Get the Pleora Protocol device's subnet mask; the GevCurrentSubnetMask feature. For the form, see #GetIPAddress. Get the Pleora Protocol device's default gateway; the GevCurrentDefaultGateway feature. For the form, see #GetIPAddress. Get the Pleora Protocol device's current IP address; the GevCurrentIPAddress feature. The form is a.b.c.d, where a through d are decimal numbers ranging from 0 to 255. Get the Pleora Protocol device's MAC address, in the form aa-bb-cc-dd-ee-ff, where aa through ff are uppercase hexadecimal numbers ranging from 0x00 to 0xFF. Information about a Pleora Protocol device. The eBUS SDK allows enumerating devices using the Pleora protocol. However, it does not allow connecting to or controlling these device. Event OnDeviceFound. This event lets you control how GigE Vision devices are treated, once found. See delegate documentation for more information. Returns a handle to a device of the PvSystem. The GetDeviceCount and GetDeviceInfo methods of PvSystem are a shortcut for users only interested in retrieving devices without having to handle the interface to device topology. Zero-based index of the device info. Valid range is [0 .. GetDeviceCount - 1]. Handle to the requested PvDeviceInfo. Returns number of device that can be enumerated from using GetDeviceInfo. Get a . Interfaces are ordered in the array as provided by the OS. The interface's index in the array; a number ranging from 0 to -1. A handle to a object, or NULL if the index is out of bounds. Gets the number of interfaces detected on the system; the range for the method. Get the version of USB3 Vision spec supported by the SDK. The high 16 bits contain the major version and The low 16 bits the minor version. Get the version of GigE Vision spec supported by the SDK. The high 16 bits contain the major version and The low 16 bits the minor version. Get and sets the maximum time to search the system for interfaces and GigE Vision devices. The maximum time the method wait for responses from GigE Vision devices before returning. Only applies to Ethernet devices as USB devices enumeration does not include the notion of wait or timeout. The maximum time to search for GigE Vision devices, in milliseconds. The default value of 1500 is generally a good value in most situations. Values beyond 100 to 60000 are set to 100 and 60000, respectively. Set / Get the priority of the threads used to search the devices Each interface has one thread that is used to asynchronously discovery devices. Only in use when searching devices using . If you change the thread priorities, it may alternate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities. Failure can produce a PvException containing one of the following result codes: OKINVALID_PARAMETERTHREAD_ERROR Finds devices until a specific device is found. Performs a standard find operation and keeps listening for answers until a specific device is found. More than one device can be found and added to the interfaces during this find operation. Do not assume only the device of interest is present in the system/interface data after this method returns. If the device of interest is found, a handle to the device info in the interface where the device was found is returned using the aDeviceInfo parameter. String representing the device to find. Can be a MAC, IP or device name. A Handle to the PvDeviceInfo object. Failure can produce a PvException containing one of the following result codes: OKNOT_FOUNDINVALID_PARAMETER Find all interfaces and GigE Vision devices reachable from this system (the PC). The and ::Find methods search for all GigE Vision devices on a network. The version searches using all interfaces on the system; the version, only one interface. The former works as if making multiple, simultaneous calls to the later, albeit concurrently. The methods are blocking and won't return for the duration set using . Finalizer. Destructor. Constructor. Find interfaces (network adapters) and GigE Vision devices reachable from this PC. PvSystem finds all interfaces (network adapters) and returns objects. finds all GigE Vision devices on a specific interface and returns objects. provides the information required to connect to a GigE Vision device. The following code snippet illustrates how to programmatically cycle through the list of interfaces and GigE Vision devices available on the network. Include PvSystemSnippet.cpp To connect to the GigE Vision device, see . To bring up a user interface that allows one to select a GigE Vision device, refer to PvDeviceFinderWnd. PvSystem device found event delegate. Reference to the interface the device was found on. Reference to information about the device. Output parameter: if set to true by the delegate handler, the device just found will be ignored/dropped. Destructor. Constructor. Gets the NIC's ID. The NIC's ID. Gets information identifying a GigE Vision device. Returns information identifying a GigE Vision device discovered on this interface (network adapter). This information can be used to connect and control it with a object. To connect, use . The GigE Vision device's array position. The zero-based parameter accepts 0 through -1. Information identifying a GigE Vision device; a object. If aIndex is out of bounds, the return is NULL.. Gets the number of found devices on this . Gets a string uniquely identifying the interface. Gets a string identifying the interface for display purpose. Get the description of the NIC, as reported by the OS. Gets the NIC's driver type. Type of interface (eBUS, regular NIC, ...). Represents one interface (network adapter or USB host controller) on a system (the PC). To use this class, see . Constructor. Returns the payload size the device is currently configured to stream with. This method attempts to read the GenICam PayloadSize parameter of the device. If the operation fails the payload size is computed from width, height and pixel format as a fall back. If even this fails, a value that is still valid to allocate buffers is finally returned. Disables streaming on the device. For GigE Vision devices, this takes care of resetting the TLParamsLocked so that changes to streaming related parameters are possible again. For USB3 Vision devices, this takes care of the TLParamsLocked and sets the streaming enable bit on the device. StreamDisable should be called after the AcquisitionStop GenICam command has been executed and all images have been received. The channel on which to disable streaming. OK NOT_CONNECTED GENERIC_ERROR INVALID_PARAMETER Disables streaming on the device. See the method to disable streaming on the device with specified channel. For GigE Vision devices, this takes care of resetting the TLParamsLocked so that changes to streaming related parameters are possible again. For USB3 Vision devices, this takes care of the TLParamsLocked and sets the streaming enable bit on the device. StreamDisable should be called after the AcquisitionStop GenICam command has been executed and all images have been received. OK NOT_CONNECTED GENERIC_ERROR INVALID_PARAMETER Enables streaming on the device. Method to enable streaming on the device with specified channel. For GigE Vision devices, this takes care of resetting the TLParamsLocked so that changes to streaming related parameters are possible again. For USB3 Vision devices, this takes care of the TLParamsLocked and sets the streaming enable bit on the device. StreamDisable should be called after the AcquisitionStop GenICam command has been executed and all images have been received. The channel on which to enable streaming. OK NOT_CONNECTED GENERIC_ERROR INVALID_PARAMETER Enables streaming on the device. See the method to enable streaming on the device with specified channel. For GigE Vision devices, this takes care of setting the TLParamsLocked so that changes to streaming related parameters are prevent in the GenICam interface of the device. For USB3 Vision devices, this takes care of the TLParamsLocked, configures the driver for streaming and sets the streaming enable bit on the device. After calling StreamEnable, the user must still execute the AcquisitionStart GenICam command of the device to instruct the device to begin acquisition. OK NOT_CONNECTED GENERIC_ERROR INVALID_PARAMETER Callback invoked after a port write. Used to report write activity on the GenApi iPort implementation of the GVCP command link of the PvDevice. The callback is invoked AFTER the write operation. The content of aBuffer represents the data that was written to the device. This callback is only invoked on a successful read operation. If the delegate aLength parameter is 4 bytes, that data is represented as a 4 byte value formatted as big-endian. If data is more that 4 bytes, it is presented as a stream of bytes requiring proper interpretation. See delegate documentation for more information. Callback invoked after a port read. Used to report read activity on the GenApi iPort implementation of the GVCP command link of the PvDevice. The callback is invoked AFTER the read operation so the content of aBuffer contains the data that was read from the device. This callback is only invoked on a successful read operation. If the delegate aLength parameter is 4 bytes, that data is represented as a 4 byte value formatted as big-endian. If data is more that 4 bytes, it is presented as a stream of bytes requiring proper interpretation. See delegate documentation for more information. Messaging channel GenICam event notification. This OnEvent handler lets users access the GigE Vision event as mapped through the GigE Vision interface of the device. Unlike the other OnEvent that provides a pointer to the raw event data, the data is provided as a list of GenICam parameters that have been invalidated when the event has been attached to the GenApi node map of the device. If events with no data or events with data not mapped in the GenICam interface of the device are received, this callback is still invoked by the parameter list containing is not provided, it is simply set to NULL. See delegate documentation for more information. Messaging channel raw event notification. If the delegate aData parameter is not NULL, it is as received on the wire in the device's endianess. All other parameters are corrected for the host's endianess. The OnEvent handler lets users access the raw GigE Vision event before it is forwarded to the GenICam layer. It is highly recommended to always use the OnEventGenICam when possible. Use of raw events assume a good knowledge of the device implementation like event ID and data mapping. See delegate documentation for more information. Callback that is invoked just after PvDevice automatically reconnects with the GigE Vision device. See delegate documentation for more information. Notification that the PvDevice unexpectedly lost contact with the GigE Vision device. See delegate documentation for more information. Set / Get the priority of the recovery thread This thread is used to fire/invoke the OnLinkDisconnected and OnLinkReconnected PvDeviceEventSink events. If you change the thread priorities, it may alternate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities. Set / Get the priority of the interrupt queue thread This thread is simply used to fire/invoke the OnLinkDisconnected and OnLinkReconnected PvDeviceEventSink events. This thread takes all messages queued for deferred processing by the interrupt link thread and fires all GenApi and PvDeviceEventSink callback. All callbacks are fired/run in the context of this thread. Set / Get the priority of the interrupt link thread Interrupt link thread receives messaging channel packets from the device, sends acknowledge back and queues the message in the interrupt queue. Process and callbacks are not done from this thread. This thread takes all messages queued for deferred processing by the interrupt link thread and fires all GenApi and PvDeviceEventSink callback. All callbacks are fired/run in the context of this thread. Set / Get the priority of the heartbeat thread The heartbeat thread priority is critical to most applications. This thread must never starve against any other system thread to the risk of losing the device connection. This thread takes all messages queued for deferred processing by the interrupt link thread and fires all GenApi and PvDeviceEventSink callback. All callbacks are fired/run in the context of this thread. Waits for the messaging channel to become idle. This method returns once the host-side messaging channel in-queue is empty or aTimeout (milliseconds) has elapsed. Maximum time to wait, in milliseconds. Failure can produce a containing one of the following result codes: TIMEOUT Writes bytes starting at a specific register address on the GigE Vision device. See warnings about accessing the register map directly in WriteRegister. Not all GigE Vision devices are supporting the write memory operation. When using this method on a device not supporting write memory operations, the write is broken down in as many write register commands as required. Start address of the write memory operation (mod 4). Buffer holding the data to write to the device. Bytes to write to the device (mod 4, non 0, max 536) Failure can produce a containing one of the following result codes: TIMEOUT Reads bytes starting at a specific register address on the GigE Vision device. See warnings about accessing the register map directly in WriteRegister. Start address of the read memory operation (mod 4). Buffer where to write data read from the device. Bytes to read from the device (mod 4, non 0, max 536) Failure can produce a containing one of the following result codes: TIMEOUT Get the parameters used to define how PvDevice connects to and communicates with the device. For a listing of all the available parameters, refer to Device Communication Parameters for either GigE Vision or USB3 Vision. The parameters used to define how PvDevice connects to and communicates with the device. The parameters used to control the GigE Vision device to which you are connected Each GigE Vision device provides its own GenICam XML file with parameters describing its behaviour referred to as features. The PvGenParameterArray object returned by this method provides an interface to these features. Returns a good default filename to use with DumpGenICamXML. The filename is built from the URL that was used in order to locate the GenICam XML file of the device. Save the GigE Vision device's GenICam XML file to disk. If the XML is stored in a zip file on the device, the zip file containing the XML is saved on the disk. The file's name. True if this PvDevice is currently connected to a GigE Vision Device, false otherwise. Test if this is currently connected to a Pleora powered GigE Vision or USB3 Vision device. True if this is currently connected to a Pleora powered GigE Vision or USB3 Vision device, false otherwise. True if this PvDevice is currently connected to a GigE Vision Device, false otherwise. Disconnect the PvDevice object from the GigE Vision device to which it is currently connected. Connect to a GigE Vision or USB3 Vision device. 1. If you know the GigE Vision device's IP address, MAC address or DeviceUserID, you can use this method to connect to it. 2. If you know the USB3 Vision device's GUID or DeviceUserID, you can use this method to connect it. 3. If aInfo contains an IP address, the connection attempt connecting a GigE Vision device is direct. An internal is used to find all reachable GigE Vision devices.Found devices are browsed, looking for a match on the MAC address.If the device is found, connection is attempted. 4. If aInfo contains a USB3 Vision GUID: All USB3 Vision devices are enumerated.Found devices are browsed, looking for a match on the GUID.If the device is found, connection is attempted. 5. If aInfo contains a device user ID: All GigE Vision and USB3 Vision are enumerated.Found devices are browsed, looking for a match on device user ID.If the device is found, connection is attempted. Information that uniquely identifies the GigE Vision device. You may use one of the following: GigE Vision device's MAC address. Use the form 00:11:22:33:44:5F.GigE Vision device's IP Address. Use the form 192.168.1.114 GigE Vision or USB3 Vision device's DeviceUserID.USB3 Vision GUID. Failure can produce a containing one of the following result codes: Connect to a GigE Vision or USB3 Vision device. The method connects to a GigE Vision device found using a or PvDeviceFinderWnd object. Only one device can be connected to at a time. The GigE Vision device's network connectivity information; a PvDeviceInfo object. Failure can produce a containing one of the following result codes: Get the device type. Dynamically allocates a PvDevice of the right type. This static method takes a generic PvDeviceInfo, creates the right type of PvDevice (PvDeviceGEV or PvDeviceU3V) and connects it. String identifying the device. See for more information. A handle to the new object on success, nullptr on failure. See aResult for more information on the failure. Dynamically allocates a PvDevice of the right type. This static method takes a generic PvDeviceInfo, creates the right type of PvDevice (PvDeviceGEV or PvDeviceU3V) and connects it. Pointer to the device information used to connect the device. A handle to the new object on success, nullptr on failure. See aResult for more information on the failure. Finalizer. Destructor. Connect, configure and control a GigE Vision device. To connect and configure a GigE Vision device to begin transmitting data: Select the GigE Vision device to which you want to connect. See , , .Connect to a GigE Vision device. Use Connect.Get the GigE Vision device's GenICam interface. Use GetGenParameters.Configure the device through the GenICam interface. See PvGenParameterArray.Configure the receiver and take note of its IP address and port.Configure your PvDevice's streaming destination using SetStreamDestination.Lock the interface for streaming. Set TLParamsLocked feature of the GigE Vision device's GenICam interface to 1.Configure the GigE Vision device to send images. Use AcquisitionStart feature of the GigE Vision device's GenICam interface.Release the interface for streaming. Set TLParamsLocked feature of the GigE Vision device's GenICam interface to 0.Configure the GigE Vision device to stop sending images. Use AcquisitionStop feature of the GigE Vision device's GenICam interface. For a complete example that illustrates the steps above, refer to the following samples: MulticastMaster - Configure a GigE Vision device to transmit.PvPipelineSample - Configure a GigE Vision device to transmit and receive the data it transmits in the same application.Recovery The SDK can let you automatically recover from problems such as accidental disconnects, power interrupts, and so on. To learn more, see PvDeviceEventSink. PvDevice command link write event delegate. Reference to the device object that invoked this callback. Pointer to the data that was written. Address of the data written to the device. Length of the data, in bytes. PvDevice command link read event delegate. Reference to the device object that invoked this callback. Pointer to the data read. Address of the data read on the device. Length of the data, in bytes. PvDevice GigE Vision messaging channel (interrupt) GenICam event delegate. Reference to the device object that invoked this callback. Event ID. Some standard GigE Vision event IDs are defined but usually device dependent. Streaming channel associated with the event, if any. 0xFFFF is used if the event is not associated to a streaming channel. Streaming block ID associated with the event, if any. Can be used to pair one or more than one event with a block received from a device. 0 is used if the event is not associated to a block. Timestamp of the event on the time domain of the device. Time unit is defined by the device. 0 if timestamps are not supported by the device that generated the event. List containing all parameters invalidated by this event. Can be null if the event carried no data or the data was does not not invalidate any GenICam parameters of the device. PvDevice GigE Vision messaging channel (interrupt) raw event delegate. Reference to the device object that invoked this callback. Event ID. Some standard GigE Vision event IDs are defined but usually device dependent. Streaming channel associated with the event, if any. 0xFFFF is used if the event is not associated to a streaming channel. Streaming block ID associated with the event, if any. Can be used to pair one or more than one event with a block received from a device. 0 is used if the event is not associated to a block. Timestamp of the event on the time domain of the device. Time unit is defined by the device. 0 if timestamps are not supported by the device that generated the event. Reference to Event Data, if applicable. Data length, in bytes. PvDevice reconnected notification (when recovery is enabled) event delegate. Reference to the device object that invoked this callback. PvDevice disconnected event delegate. Reference to the device object that invoked this callback. Device type. U3V device type. GEV device type. Unknown device type. The type of driver that would be leveraged for streaming data on this interface. Network interface type. USB host controller type. Low noise threshold. High noise threshold. Sharp maximal threshold. Sharp parameter. Global gain of white balance. Pan gain of white balance. Blue gain of white balance. Green gain of white balance. Red gain of white balance. Dark floor of the raw image. Convert an image from TRUESENSE(TM) to RGB. The original image. The destination image. Depending on the conversion, the memory footprint of the new image may be greater than aDestination current size. By setting this parameter to true, the image is re-allocated if aDestination is too small. If aDestination memory image is not owned by the PvImage> and is too small, Convert fails. Failure can produce a containing one of the following result codes: INVALID_DATA_FORMAT.GENERIC_ERROR. Convert an image from TRUESENSE(TM) to RGB. The original image. The destination image. Failure can produce a containing one of the following result codes: INVALID_DATA_FORMAT.GENERIC_ERROR. Test if a pixel type can be converted to another type. Converting from one pixel type to another isn't a trivial mathematical calculation - all conversions require specialized, dedicated algorithms. The IsConversionSupported function tests if the Convertmethod has an available conversion algorithm. The original pixel type. For available pixel types, see PvPixelType.h. The new pixel type. See aSource. True if Convert has an available conversion algorithm; otherwise, false. Finalizer. Destructor. Constructor. Converts images from TRUESENSE(TM) to RGB. This class can be used to convert Sparse Color Filter TRUESENSE(TM) images (SCF1) into RGB8 or RGBa8. The image quality is expected to be much better than SCF1 conversion performed using PvBufferConverter. The intense image processing algorithms used to obtain this high quality yields much higher processing times. Various gain and filtering parameters can be used to tweak the image conversion. SCF1 12-unpacked is recommended as input pixel type for slightly better processing times. Other SCF1 pixel types are also supported but must internally be converted to 12-unpacked before being converted to RGB. \brief Fires the mouse-over-pixel event \brief Returns the ROI \brief Sets the ROI programmatically \brief Clears (resets) the ROI \brief Enter mode where the mouse is used to create a new ROI \brief Mouse move event handler \brief Mouse move event handler \brief Handles ROI pan aX, aY: mouse position in image coordinates \brief Checks ROI top vs bottom and flips them + anchor if needed \brief Checks ROI left vs right and flips them + anchor if needed \brief Handles a new ROI Y-resizing aX: mouse Y on image-coordinates \brief Handles a new ROI X-resizing aX: mouse X on image-coordinates \brief Updates the mouse cursor if needed vs ROI anchors aX, aY: cursor coordinates in client pixels \brief Mouse move event handler \brief Draws the ROI \brief Converts a client point to a ROI point \brief Converts a ROI rectangle to a client rectangle \brief Refreshes the ROI \brief Lost focus event handler \brief Got focus handler \brief Timer handler Invalidates nodes having reach their defined polling time since last update. Goes through all parameters having polling times defined and invalidates those that need to be invalidated based on the last time they were invalidated. Failure can produce a containing the following result code: If an error happened within GenApi. The exception message contains more information about the error. Returns the access mode of the port of the GenICam node map. Detach previously attached data chunks. Failure can produce a containing the following result code: If an error happened within GenApi. The exception message contains more information about the error. Attaches a payload containing data chunks to a GenICam node map. Takes the content of a PvBuffer and attempts to parse the chunks from the end of the buffer. Chunk IDs from the buffer matching chunk IDs in the node map are available through the node map once the buffer is attached. Using GenICam instead of the PvBuffer raw chunk methods access allows to access the chunks as structured data, as long as the chunks are described in the GenICam XML file of the device. Pointer to the a PvBuffer containing data chunks Failure can produce a containing the following result code: The buffer is not attached or allocated or has invalid size.If an error happened within GenApi. The exception message contains more information about the error. Help method used to directly execute a command parameter of this parameter array. Name of the parameter to execute. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenCommand.Execute Helper method used to directly retrieve the range of a float parameter. Name of the parameter. Minimum. Maximum. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type Any other error code from PvGenFloat.Min or PvGenFloat.Max Helper method used to directly retrieve the range of an integer parameter. Name of the parameter. Minimum. Maximum. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type Any other error code from PvGenInteger.Min or PvGenInteger.Max Help method used to directly write a string parameter value of this parameter array. Name of the parameter to write the value to. Value written to the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenString.Value Helper method used to directly read a string parameter value of this parameter array. Name of the parameter to read the value from. String parameter handle from the parameter array. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenString.Value Help method used to directly write a Boolean parameter value of this parameter array. Name of the parameter to read the value from. Value written to the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenBoolean.Value Help method used to directly read a Boolean parameter value of this parameter array. Name of the parameter to read the value from. Value written to the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenBoolean.Value Help method used to directly write an enumeration parameter value (as an integer) of this parameter array. Name of the parameter to write the value to. Value written to the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenEnum.Value Help method used to directly write an enumeration parameter value (as a string) of this parameter array. Name of the parameter to write the value to. Value written to the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenEnum.Value Helper method used to directly read an enumeration parameter value (as an integer) of this parameter array. Name of the parameter to read the value from. Value read from the parameter, integer representation. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenEnum.Value Helper method used to directly read an enumeration parameter value (as a string) of this parameter array. Name of the parameter to read the value from. Value read from the parameter, string representation. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenEnum.Value Help method used to directly write a float parameter value of this parameter array. Name of the parameter to write the value to. Value written to the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenFloat.Value Helper method used to directly read a float parameter value of this parameter array. Name of the parameter to read the value from. Value read from the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenFloat.Value Help method used to directly write an integer parameter value of this parameter array. Name of the parameter to write the value to. Value written to the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type.Any other error code from PvGenInteger.Value Help method used to directly read an integer parameter value of this parameter array. Name of the parameter to read the value from. Value read from the parameter. Failure can produce a containing the following result code: if the parameter does not exist or is not the right type Any other code from PvGenInteger.Value Help method returning a PvGenParameter casted as a PvGenRegister. Returns NULL if the parameter does not exist in the node map or the parameter is not a register. Name of the parameter. PvGenRegister parameter handle from the parameter array. Help method returning a PvGenParameter casted as a PvGenString. Returns NULL if the parameter does not exist in the node map or the parameter is not a string. Name of the parameter. PvGenString parameter handle from the parameter array. Help method returning a PvGenParameter casted as a PvGenCommand. Returns NULL if the parameter does not exist in the node map or the parameter is not a command. Name of the parameter. PvGenCommand parameter handle from the parameter array. Help method returning a PvGenParameter casted as a PvGenBoolean. Returns NULL if the parameter does not exist in the node map or the parameter is not a Boolean. Name of the parameter. PvGenEnum parameter handle from the parameter array. Help method returning a PvGenParameter casted as a PvGenEnum. Returns NULL if the parameter does not exist in the node map or the parameter is not an enumeration. Name of the parameter. PvGenEnum parameter handle from the parameter array. Help method returning a PvGenParameter casted as a PvGenFloat. Returns NULL if the parameter does not exist in the node map or the parameter is not a float. Name of the parameter. PvGenFloat parameter handle from the parameter array. Help method returning a PvGenParameter casted as a PvGenInteger. Returns NULL if the parameter does not exist in the node map or the parameter is not an integer. Name of the parameter. PvGenInteger parameter handle from the parameter array. Invalidates the cache of the GenICam parameter array. Failure can produce a containing the following result code: (Use to get more information). Get a category ( object) from the array (using category name). The category's name. See . The category ( object) , or NULL if the name does not match any categories in the array. Get a category ( object) from the array (using array position). The category's position in the array. The valid range for aIndex is: 0 =< aIndex < . The category ( object) , or NULL if the index is out of bounds. Get the number of categories ( object) in the array. Get a parameter ( object) from the array (using parameter name). The parameter's name. . The parameter ( object), or NULL if the name does not match any parameters in the array. Get a parameter ( object) from the array (using parameter name). The parameter's position in the array. The valid range for aIndex is: 0 =< aIndex < . The parameter ( object), or NULL if the index is out of bounds. Get the number of parameters ( object) from the array (using parameter name). The parameter's name. . The parameter ( object), or NULL if the name does not match any parameters in the array. Get the number of parameters ( object) from the array (using parameter name). The parameter's position in the array. The valid range for aIndex is: 0 =< aIndex < . The parameter ( object), or NULL if the index is out of bounds. Get the number of parameters ( object) in the array. Finalizer. Destructor. GenICam feature array.

Controlling features (programmatically)

 To control features: 1- Get the list of features. Use one of the following: PvDevice.Parameters (Parameters used to control the GigE Vision device to which you are connected). PvDevice.CommunicationParameters (Parameters used to define how PvDevice connects to and communicates with the device - see Device Communication Parameters for either GigE Vision or USB3 Vision devices. PvStream.Parameters (Parameters used to define how PvStream receives data from a GigE Vision transmitter - see Stream Parameters for either GigE Vision or USB3 Vision device.. 2- Get a feature. Use . 3- Get the feature's type. Use . 4- Optionally: Get/Set the feature's value. Use the Value attribute for the feature's type (e.g. PvGenInteger.Value, etc).If the feature is a command, activate it. Use PvGenCommand.Execute.

Controlling features (using a GUI)

 To control features (using a GUI): see PvGenBrowserWnd

Running code when a feature's value changes

 In some cases, you may want to know when a feature value or attribute changes without using CPU-intensive polling to regularly check (and re-check) the feature's value. To create a callback that runs when the feature's value changes: Get the feature. See Controlling features. Create a subclass of . Use the PvGenParameter events and delegates to be notified when a parameter is invalidated. GenICam access mode. Undefined mode. Not available mode. Not implemented mode. Write only mode. Read write mode. Read only mode. Gets the category's namespace. Failure can produce a containing the following result code: (Use to get more information). Gets the category's display name. Failure can produce a containing the following result code: (Use to get more information). Gets the category's tool tip. Failure can produce a containing the following result code: (Use to get more information). Gets the category's description. Failure can produce a containing the following result code: (Use to get more information). Gets the category's name. Failure can produce a containing the following result code: (Use to get more information). Destructor. GenICam category. In group: GenICam features. Returns the length of the register mapped with this feature. Reads from the register. Partial (less than ) reads are supported at the GenICam level, but the behavior is defined by the device. Data read from the register. Length of the buffer, in bytes. Write to the register. Partial (less than ) reads are supported at the GenICam level, but the behavior is defined by the device. GigE Vision enforces a mod-4 (can be divided by 4 bytes) length restriction on all read/write operations. Data write to the register. Length of the buffer, in bytes. Destructor. GenICam feature: Register or IRegister. To use this class, see . A feature providing direct access to a section of the device's register map. Get the maximum length of the string. Feature value accessor. On failure returns a PvResult instead of raising an exception. Output that on success will contain the parameter value. Result of the operation. (Use to get more information). Get and set the feature's value. Destructor. GenICam feature: String. To use this class, . Query whether the command is executed. True if the command has completed its execution, false otherwise. Failure can produce a containing the following result code: (Use to get more information). Activate the feature. Failure can produce a containing the following result code: (Use to get more information). Destructor. GenICam feature: Command. A feature that can only be activated. In group: GenICam features. To use this class, see . Feature value accessor. On failure returns a PvResult instead of raising an exception. Output that on success will contain the parameter value. Result of the operation. (Use PvResult.Description to get more information). Gets and sets the feature's value. Failure can produce a containing the following result code: (Use to get more information). Destructor. GenICam feature: Boolean. A feature that can either be true or false. In group: GenICam features. Get an enumerator that iterates through a collection. An enumerator that iterates through a collection. Gets an enumerator. An enumerator. Gets an enumeration entry (by value). On failure returns a PvResult instead of raising an exception. The enumeration entry's value (PvGenEnum.Value). Output that on success will contain a reference to the enumeration entry. Result of the operation. (Use PvResult.Description to get more information). Gets an enumeration entry (by value). The enumeration entry's value (PvGenEnum.Value). The enumeration entry Failure can produce a containing the following result code: (Use to get more information). Gets an enumeration entry (by list position). The enumeration entry's position in the list. The enumerator ( object) has a list that ranges from 0 to PvGenEnum.EntriesCount. The enumeration entry Failure can produce a containing the following result code: (Use to get more information). Gets an enumeration entry (by name). The enumeration entry's name (PvGenEnumEntry.Name). The enumeration entry Failure can produce a containing the following result code: (Use to get more information). Gets and sets the feature's value as a string. Failure can produce a containing the following result code: (Use to get more information). Feature value accessor. On failure returns a PvResult instead of raising an exception. Output that on success will contain the parameter value. Result of the operation. (Use PvResult.Description to get more information). Feature value accessor. On failure returns a PvResult instead of raising an exception. Output that on success will contain the parameter value. Result of the operation. (Use PvResult.Description to get more information). Gets and sets the number of enumeration entries. Failure can produce a containing the following result code: (Use to get more information). Gets and sets the feature's value as an integer. Failure can produce a containing the following result code: (Use to get more information). Finalizer. Destructor. GenICam feature: Enumeration. A feature that can take one of many defined values. In group: GenICam features. PvGenEnum is a list of selectable values. In a UI, PvGenEnum objects are typically represented as dropdown lists. Each list entry is a object. Thus, the enumeration list might be represented as:
List position Entry value Entry name
0 5 Orange
1 4 Apple
2 99 Watermelon
However, the UI presents only a selection of entry names (Orange, etc.); the list position and entry values are hidden. The entry names are always unique. Enumerations can't be set to any arbitrary value; they can only be set to a value of an entry on the list. If a user selected Orange, you could set the new value in the following ways: Set the entry value directly with = 5. Set the entry value by the name with = "Orange". Get an enumerator that iterates through a collection. An enumerator that iterates through a collection. Gets an enumerator. An enumerator. Constructor Abstract class to iterate over a non-generic collection. A generic class. Test if the enumeration entry is currently available. See PvGenParameter.IsAvailable. Failure can produce a containing the following result code: (Use to get more information). Test if the parameter is visible at the specified visibility level. Visibility level. See . Failure can produce a containing the following result code: (Use to get more information). Gets the enumeration entry's current visibility level.. Failure can produce a containing the following result code: (Use to get more information). Gets the enum entry's namespace. Failure can produce a containing the following result code: (Use to get more information). Gets the enum entry's display name. Failure can produce a containing the following result code: (Use to get more information). Gets a longer description of the enum entry. Failure can produce a containing the following result code: (Use to get more information). Gets a short description of the enum entry. Failure can produce a containing the following result code: (Use to get more information). Gets the enumeration entry's name. Failure can produce a containing the following result code: (Use to get more information). Gets the enumeration entry's value. Failure can produce a containing the following result code: (Use to get more information). Destructor. GenICam feature: Enumeration entry. In group: GenICam features. To use PvGenEnumEntry, see PvGenEnum. Gets the feature's measurement unit. The Unit property returns a string with the units for the feature. For example, the string might contain "pixels", "bytes", "ms", and so on. The string is informational and has no intrinsic value for converting to other units. Failure can produce a containing the following result code: GENERIC_ERROR (Use to get more information). Gets the feature's suggested presentation format. See PvGenRepresentation. Failure can produce a containing the following result code: GENERIC_ERROR (Use to get more information). Gets the feature's limits (maximum). Failure can produce a containing the following result code: GENERIC_ERROR (Use to get more information). Gets the feature's limits (minimum). Failure can produce a containing the following result code: GENERIC_ERROR (Use to get more information). Feature value accessor. On failure returns a PvResult instead of raising an exception. Output that on success will contain the parameter value. Result of the operation. GENERIC_ERROR (Use to get more information). Gets and set the feature's value. Failure can produce a containing the following result code: GENERIC_ERROR (Use to get more information). Destructor. GenICam feature: Float. In group: GenICam features. To use this class, see . Gets the feature's suggested presentation format. Failure can produce a containing the following result code: (Use to get more information). Gets the feature's suggested increment. The property Increment suggests how much an up/down button in the UI should increment/decrement the current value. For example, a feature with a range of 0 to 1000000 might have an increment of 100000 to keep the user from having to click excessively. Failure can produce a containing the following result code: (Use to get more information). Gets the feature's limits (maximum). Failure can produce a containing the following result code: (Use to get more information). Gets the feature's limits (minimum). Failure can produce a containing the following result code: (Use to get more information). Feature value accessor. On failure returns a PvResult instead of raising an exception. Output that on success will contain the parameter value. Result of the operation. (Use to get more information). Gets and sets the feature's value. Failure can produce a containing the following result code: (Use to get more information). Destructor. GenICam feature: Integer. In group: GenICam features. To use , see . Suggests how the UI should present a numerical feature. To get a feature's representation, use the following attributes: PvGenFloat.Representation PvGenInteger.Representation Not defined; valid representation not provided. Hex number. Use an edit box with a hexadecimal display. Pure number. Use an edit box with a decimal display. Boolean. The number might be presented as a check box or enable. Use a similar UI as for features from the PvGenBoolean class. Logarithmic. Use a slider. The GenICam standard doesn't specify if the feature's value represents x or y in the formula x = n ^ y. Linear. Use a slider. Sets the parameter value from a string. A string representing the new value to set the parameter to. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter value as a string. A string representing the parameter value. Failure can produce a containing the following result code: if the operation fails. Use for more information. Event OnParameterUpdateHandler. See delegate documentation for more information. Gets all selectors for this parameter. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets all parameters selected by this parameter. Queries whether this parameter is a selector or not. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the visibility setting. Failure can produce a containing the following result code: if the operation fails. Use for more information. Test if the parameter is visible at the specified visibility level. Visibility level. True if the specified visibility level is visible, otherwise false. Failure can produce a containing the following result code: if the operation fails. Use for more information. Test if the parameter can be streamed. Failure can produce a containing the following result code: if the operation fails. Use for more information. Test if the parameter is readable. Failure can produce a containing the following result code: if the operation fails. Use for more information. Test if the parameter is writable. Failure can produce a containing the following result code: if the operation fails. Use for more information. Test if the parameter is currently available, but may be available later on. Failure can produce a containing the following result code: if the operation fails. Use for more information. Test if the parameter is to be considered when saving the state of a GenICam interface to disk. Failure can produce a containing the following result code: if the operation fails. Use for more information. Test if the parameter's value is cached in the PC. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter's namespace. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter's display name. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter's description. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter's tooltip. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter's category. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter's type. Failure can produce a containing the following result code: if the operation fails. Use for more information. Gets the parameter's name. Failure can produce a containing the following result code: if the operation fails. Use for more information. Finalizer. Destructor. Base class for all GenICam feature types. PvGenParameter updated event delegate. Reference to the parameter invoking the event delegate. Enumeration PvGenVisibility. Every feature has a visibility setting that suggests how difficult the feature is to use and when it shouldn't be made available (visible) to the end user. The current visibility might be a program-specific variable available, for example, in an options or configuration dialog. When opening the program for the first time, the visibility would typically be set to beginner. If a program's current visibility were set to Expert, the user would expect to see Beginner and Expert-level features, but not Guru or Invisible-level features. Not defined; valid visibility not provided. Appears in the API, but not the GUI. Intended for very advanced users. Intended for advanced users. Always visible, to all users. GenICam namespace. GenICam undefined namespace. GenICam custom namespace. GenICam standard namespace. Enumeration PvGenType. Feature data type (Boolean, integer, etc.). Each feature has a type that defines the information it contains and how it can be used. The type also determines the SDK class used to represent it (and the methods that are available). Undefined (not initialized) feature type. Feature of type PvGenRegister. Feature of type PvGenFloat. Feature of type PvGenCommand. Feature of type PvGenString. Feature of type PvGenBoolean. Feature of type PvEnum. Feature of type PvInteger. Returns a reference to the internal buffer converter. When writing the buffer to a file requires a conversion, it is performed automatically by the PvBufferWriter. The converter used for this operation can be configured using this method. As an example, a RGB filter could be set or the Bayer interpolation method could be selected. Saves a to disk. This method lets you save an image buffer ( object) to disk in a variety of formats. If a conversion to color is required, it happens automatically within the method. If no conversion to the required color format is available, Store fails. The image to save. The filename, including extension. The format uses the same standard as the C fopen function. In C/C++, valid filenames include "myfile.raw", "..\\myfile.bmp", "C:\\myfile.bmp". The format of the image; a PvBufferFormatType enumeration. A close approximation of how many bytes were written to the file. Failure can produce a containing one of the following result codes: (e.g. invalid PvBufferFormatType).(The buffer can't be converted to the specified type). Finalizer. Destructor. Constructor. Saves the contents of a object to a raw data file or bitmap. To save an image buffer to disk: Acquire an image. See . Create an image save. Use PvBufferWriter.PvBufferWriter. Save the image to disk. Use . Set / Get the priority of the threads doing the conversion. By default one conversion thread is created for each processing core of the system. We only allow setting priority for the threads of one converter object as a group. If you change the thread priorities, it may affect the stability of the system. When communicating with your Pleora representative, ensure you tell them that you have changed the thread priority. Assigns a RGB filter to be used during conversion. The configuration of the filter is copied to the internal converter's RGB filter. Changing aFilter after calling this method has no effect on the RGB filtering performed during conversion. The RGB filter to be used during conversion. Resets the RGB filter used for conversion (if any). Gets and sets current optional Bayer filtering; filter's type is a PvBayerFilterType enumeration. Convert a buffer from one format to another. The original image/buffer. The new image/buffer. Depending on the conversion, the memory footprint of the new image may be greater than aDestination current size. By setting this parameter to true, the buffer is re-allocated if aDestination is too small. If aDestination memory buffer is not owned by the and is too small, Convert fails. If true, while converting the image is flipped on its Y axis. Failure can produce a containing one of the following result codes: INVALID_DATA_FORMAT.GENERIC_ERROR. Convert a buffer from one format to another. The original image/buffer. The new image/buffer. Depending on the conversion, the memory footprint of the new image may be greater than aDestination current size. By setting this parameter to true, the buffer is re-allocated if aDestination is too small. If aDestination memory buffer is not owned by the and is too small, Convert fails. Failure can produce a containing one of the following result codes: INVALID_DATA_FORMAT.GENERIC_ERROR. Convert a buffer from one format to another. There is one overload for this method, refer to the other overload method: . The original image/buffer. The new image/buffer. Failure can produce a containing one of the following result codes: INVALID_DATA_FORMAT./> GENERIC_ERROR./> Test if a pixel type can be converted to another type. Converting from one pixel type to another isn't a trivial mathematical calculation - all conversions require specialized, dedicated algorithms. The IsConversionSupported method tests if the Convert function has an available conversion algorithm. The original pixel type. For available pixel types, see PvPixelType.h. The new pixel type. See aSource. True if Convert has an available conversion algorithm; otherwise, false. Finalizer. Destructor. Constructor. Maximum number of threads the buffer converter is allowed to use in order to speed up conversion. If 0 or smaller than 0, one thread per processor is assumed. Threads have no specific processor affinity. Constructor. Used to convert a PvBuffer to another pixel type. To change an image's format: Acquire an image. See PvStream.RetrieveBuffer. Create an image-format converter ( object). PvBufferConverter.PvBufferConverter. Test if you can convert your image to your preferred pixel type. Use . For your source pixel type, use PvBuffer.GetPixelType; for your destination, select an enumeration from PvPixelType.h. Create a destination buffer. See (you define the destination image's pixel type during this step). Optionally, configure options like Bayer filtering, use . Convert the image to the new pixel type. Use . Thread priority types. Defined and used by the eBUS SDK as System.Threading.ThreadPriority does not expose the idle and critical priorities. THREAD_PRIORITY_TIME_CRITICAL. THREAD_PRIORITY_HIGHEST. THREAD_PRIORITY_ABOVE_NORMAL. THREAD_PRIORITY_NORMAL. THREAD_PRIORITY_BELOW_NORMAL. THREAD_PRIORITY_LOWEST. THREAD_PRIORITY_IDLE. Filter settings for the PvBufferConverter.BayerFilter property. 3x3 kernel considered when converting from Bayer. 2x2 nearest neighbor used when converting from Bayer. Reset the RGB filter configuration. This method resets the RGB filter configuration (#PvBufferConverterRGBFilter) to its default values. Gains are set to 1; offsets, to 0. After a reset, applying the filter doesn't change the image. Calculate white-balance gains. The WhiteBalance method receives an image and calculates appropriate gains to white-balance the image. Internally, the #WhiteBalance method uses the following procedure: Calculate the average colors in the image: Bavg, Gavg, Ravg.Select the maximum of the three averages: Max = max (Bavg, Gavg, Ravg).Set the new gains, where Bgain = Max / Bavg, Ggain = Max / Gavg and Rgain = Max / Ravg The WhiteBalance method produces the best results for images that have an even mix of dark and light tones, and an even mix of colors. The sample image; the image upon which to base the white-balance settings. Failure can produce a containing one of the following result codes: INVALID_PARAMETER. B offset (addition) of the RGB filter G offset (addition) of the RGB filter R offset (addition) of the RGB filter B gain (multiplier) of the RGB filter G gain (multiplier) of the RGB filter R gain (multiplier) of the RGB filter Finalizer. Destructor. Constructor. Contains a RGB filter configuration that can be used with a PvBufferConverter. To configure an RGB filter (manual): Create an RGB filter controller.Set the filter's values. Use SetGain* and SetOffset* methods. To configure a white balance filter (automatic): Create an RGB filter object.Calculate and apply white-balance settings. Use WhiteBalance. Returns payload size in bytes, excluding any extra padding. Gets the size in bytes of the block received by the data receiver including, if present, additional chunk data and headers. Different than GetAcquiredSize as it does not include optional additional padding when data chunks are present. If data chunks are not present, this method returns the same value as GetAcquiredSize as extra padding is only an issue when data chunks are present. This method is required in order to parse the chunk data using GenICam. Payload size in bytes, excluding any extra padding. Returns a const pointer to the data chunk with its ID matching aID. If the aID chunk is not found or the PvBuffer does not have any chunks NULL is returned. Data chunk ID. Point to chunk data. NULL if aID is not found. Returns a pointer to the data chunk at zero-based aIndex. Chunks are enumerated from the end of the payload data to its beginning. If the index is out of range or the PvBuffer does not have any data chunk NULL is returned. Data chunk index. Point to chunk data. NULL if aIndex is out of range. Returns the size in bytes of the data chunk identified by aID. If the aID chunk is not found or the PvBuffer does not have any chunks 0 is returned. Data chunk ID. Data chunk size. 0 if the chunk ID is not found. Returns the size in bytes of the data chunk at zero-based aIndex. Chunks are enumerated from the end of the payload data to its beginning. If the index is out of range or the PvBuffer does not have any data chunk 0 is returned. Data chunk index. Data chunk size. 0 if the index is out of range. Returns the ID of a chunk based on its index. If the index is out of range or the PvBuffer does not have any data chunk 0 is returned in aID. Data chunk index. Failure can produce a containing one of the following result codes: The ID of a chunk based on its index. Returns the number of data chunks in the PvBuffer. If no data chunks are available, 0 is returned. Counting chunks requires the chunks to be parsed and resolved which has a performance hit. If you need to access chunks directly, you need to use this method to enumerate the chunks. If you access the chunks through GenICam, just use HasChunks to see if you need to attach the buffer the GenICam parameter array of the device. \Returns true if the buffer has data chunks. Unlike GetChunkCount, chunks do not need to be parsed or resolved with this method. Gets the interface to the buffer or NULL, depending on payload type. If the payload type of the PvBuffer is PvPayloadTypeRawData, a reference to a interface of the buffer is returned. If the payload type of the PvBuffer is NOT PvPayloadTypeRawData, a null reference is returned. This handle is owned by the PvBuffer and does not need to be released after use. It is valid as long as the PvBuffer exists. Gets the interface to the buffer or NULL, depending on payload type. If the payload type of the PvBuffer is PvPayloadTypeImage, a reference to the interface of the buffer is returned. If the payload type of the PvBuffer is NOT PvPayloadTypeImage, a null reference is returned. This handle is owned by the PvBuffer and does not need to be released after use. It is valid as long as the PvBuffer exists. Gets a missing packet group that represents an unpopulated area of memory in this buffer. This is an advanced feature that requires knowledge of how GigE Vision data is transmitted. Refer to for further details on how this feature is used. The index of the missing packet group being retrieved. The first packet of a range of missing packets. The last packet of a range of missing packets. A value of 0xFFFFFF ( or 0xFFFFFFFF for ExtendedID ) indicates that the last packet of the block went missing and therefore the actual size of the block is unknown. Failure can produce a containing one of the following result codes: NOT_AVAILABLE.NOT_IMPLEMENTED./> Gets the number of missing packet groups that represent unpopulated areas of memory in this buffer. This is an advanced feature that requires knowledge of how GigE Vision data is transmitted. When receiving data from a GigE Vision transmitter, network conditions may prevent the successful delivery of all the data for a given block. Although the eBUS data receiver provides a mechanism for requesting lost packets, there are cases when it is desirable to ignore missing packets and make use of a buffer that contains missing information. In some cases, there are portions of a block that are less important and can thus be disregarded. GetMissingPacketIdsCount and GetMissingPacketIds can provide information about which packets were lost. To use this feature take note of the following procedure: Enable the feature that causes the data receiver to keep track of missing packets (see the EnableMissingPacketsList property of PvStream parameters). Optionally disable the mechanism that requests lost packets (see the RequestMissingPackets property of PvStream parameters). Check the operation result when a new block is received (see ). If the operation result is MISSING_PACKETS, use property MissingPacketIdsCount to determine how many groups of packets are missing. Iterate through the missing packet groups using . Note that there is no particular order to the missing packet groups that are returned. Take note of the packet size set on the GigE Vision transmitter from which you are receiving to determine the areas of the payload where information is missing. True if this buffer has valid trailer (GVSP) information. If the buffer trailer is not valid (missing) some information about the buffer could be missing. As an example, the image payload type confirms the number of lines received in the trailer. When a buffer is attached or allocated for use other than receiving GVSP data, this attribute evaluates to true in order to appear as valid. True if this buffer has valid header (GVSP) information. If the buffer header is not valid (missing) the buffer has to be manipulated with extreme caution. To start with, it is impossible to confirm the payload type. The timestamp and other shared header information is not valid. Finally, information specific to some payload types (like with, height, pixel format, etc. for the image payload type) is not available or valid this buffer. When a buffer is attached or allocated for use other than receiving GVSP data, this attribute evaluates to true in order to appear as valid. Check if the buffer is currently in extended ID mode. When the extended ID mode is not enabled, the maximum block ID is 0xFFFFFF and the maximum packet ID is 0xFFFFFF as per the GEV 1.X specification. When the extended ID mode is enabled, the maximum block ID is 0xFFFFFFFFFFFFFFFF and the maximum packet ID is 0xFFFFFFFF as per the GEV 2.X specification. When a PvBuffer is received, the extended ID mode is initialized based on the information received by the PvStreamLib.Stream. When a PvBuffer is sent, the extended ID mode will be initialized by the PvTransmitterGEV according to its configuration. Returns true if the extended mode is in usage. Number of packets received out of order. Number of packets received more than once. Packets received that were ignored when this buffer was filled by the data receiver. Packets that were not successfully delivered when this PvBuffer was filled by the data receiver. The number of packets the data receiver requests with ResendGroupRequested. The number of resend requests issued by the data receiver. The number of lost packets successfully recovered by packet resend requests without any resend request retries. The number of lost packets successfully recovered by packet resend requests. Duplicate received packets are not counted. Gets the value of aOperationResult when this buffer was last received through a PvStream. See also PvStream::RetrieveBuffer, PvPipeline::RetrieveNextBuffer. Buffers with BUFFER_TOO_SMALL, ABORTED, NOT_CONNECTED and NO_MORE_ITEM operation results are never returned to the user with PvPipeline. PvPipeline handles these operation results internally without returning the buffers. Buffers with these operation results can only reach the user when using PvStream directly. Result of the acquisition operation; Includes: for images with grabber issues like data overrun or missing lines (complete or partial) \brief \return Get the buffer's reception time. The buffer's reception time on the host, in ms. Not an absolute time value. Gets the buffer's timestamp. For Pleora GigE Vision devices, this is the value of the GevTimestampValue when it began receiving data from the camera head (on the rising edge of the FVAL). Gets the block ID. This method returns the block ID. The GigE Vision transmitter typically increments the value by 1 for each new image. You can use this value to ensure the blocks are in order and that none are missing. The value is unsigned and wraps around to 1 (skipping 0) when it reaches 65536. Releases an attached memory buffer. Does nothing other than resetting the memory buffer pointer to NULL. The buffer's location in memory. Attach this PvBuffer to an external memory buffer. To use an internal memory buffer, use . A pointer to the buffer. The size of the buffer, in bytes. Failure can produce a containing the following result code: INVALID_PARAMETER. Gets the buffer's data pointer. To set the memory location, use or . Frees (de-allocates) the buffer's internal memory. Allocates memory for this PvBuffer. The size of the buffer, in bytes. Failure can produce a containing the following result code: NOT_ENOUGH_MEMORY. Reconstruct the object with a new payload type. The default payload type is PvPayloadTypeImage. Reconstruct the object with a default payload type PvPayloadTypeImage. There is one overload for this method, refer to the other overload method: Gets the buffer's size (total capacity, allocated or attached) in bytes. Gets the size, in bytes of the payload received by the data receiver. This property is not necessarily equal to (Width * Height * BitsPerPixel) / 8 + (PaddingX * Height + PaddingY) for an image. Gets the buffer's ID. Gets the payload type currently used by the buffer. Finalizer. Destructor. Constructor. The block type (default is PvPayloadTypeImage). Constructor. Represents a block of GigE Vision data in memory. A PvBuffer object is typically used to receive data from a GigE Vision transmitter or to transmit data to a GigE Vision receiver. To learn about receiving data from a GigE Vision transmitter, see PvStream. To learn about transmitting GigE Vision data to a GigE Vision receiver, see PvTransmitterGEV. A block of GigE Vision data has an associated payload which can be an image, raw data, file, chunk data, extended chunk data or device specific. In order to access the payload specific data, use property in order to get a handle to an interface giving you access to payload specific methods and properties. The current payload type of a PvBuffer can be determined by using the method. In this section: Creating and configuring buffers. Accessing payload type specific data. Processing images.

Creating and configuring buffers

 To determine the payload type and access payload type specific data: Retrieve the PvPayloadType using . If PvPayloadType is PvPayloadTypeImage, retrieve reference from your PvBuffer. Access image specific data through the reference, like , , etc. There is no need to release or delete the reference. It is valid as long as the PvBuffer exists.

Processing images

 To process an image: Retrieve a interface to the buffer use property.. Test the success of the image acquisition. Use the aOperationResult parameter in PvStream::RetrieveBuffer or PvBuffer::GetOperationResult. Process the image using your own code. You may process the image in place, if you wish. Use: PvImage.AcquiredSize. PvImage.Height and PvImage.Width. PvImage.OffsetX and PvImage.OffsetY. Releases an attached memory buffer. Does nothing other than resetting the memory buffer pointer to NULL. See Attach( System::Byte * aRawBuffer, UInt64 aPayloadLength ). The buffer's location in memory. Attach this to an external memory buffer. This method is identical to , with the following exceptions: This method uses an external memory buffer, controlled by the caller. A reference to the buffer. The payload length of the raw data, in pixels.. See property . Failure can produce a containing the following result code: Frees (de-allocates) the buffer's internal memory. See . Allocates memory for this PvRawData. Allocs a PvRawData of specific payload length. The payload length of the raw data, in pixels. See property . Failure can produce a containing the following result code: Get the payload length specified in the leader information of this block. Raw data interface to a PvBuffer. A PvBuffer represents a generic buffer with no specific payload type. If the payload type is raw data (according to the GigE Vision specification), the user can obtain a reference to a PvRawData buffer interface through PvBuffer.RawData. Returns whether a pixel type is higher than 8-bit per channel or not. Pixel type. The pixel bit count. Returns whether a pixel type is color or not. Pixel type. True if color, false otherwise. Gets the pixel bit count according to the pixel type. Pixel type. The pixel bit count. Data overrun status bit. True if there was a data overrun. False otherwise. Image dropped status bit. True if the previous frame was dropped. False otherwise. The image contained in the PvImage is an interlaced Odd field. True interlaced Odd field. False otherwise. The image contained in the PvImage is an interlaced Even field. True interlaced Even field. False otherwise. End of Frame by Line Count status bit. True if previous frame was NOT the last one of a sequence of sub frames, false otherwise. If true, the grabber (on the device) was missing at least one line when the frame was grabbed, false otherwise. If true, the grabber (on the device) was missing at least one pixel in at least one of the lines when the frame was grabbed, , false otherwise. Copies the content of a .NET Bitmap to the PvImage. Prior to the copy, the PvImage is resized to hold the complete bitmap. The PvPixelType is used as destination. Color BGRA8Packed, BGR8Packed, RGBA8Packed, RGB8Packed, WinRGB24, WinBGR24, WinRGB32 and WinBGR32 PvPixelType are currently supported. The input has to be either Format32bppRgb, Format32bppArgb or Format24bppRgb. The bitmap from which to copy the data. The pixel type to convert to when copying the data to the PvImage. Failure can produce a containing the following result code: if the conversion is not supported. Converts the PvImage content to a .NET Bitmap. The bitmap needs to be allocated to have the same width and height as the PvImage. The pixel type of the bitmap needs to be set at Format24bppArgb, Format32bppRgb or Format32bppArgb. The bitmap to copy the image data to. Failure can produce a containing the following result code: if the bitmap is not properly allocated. if the conversion is not supported. Generates a simple test pattern from a seed. Not all pixel types are supported. This method is simply provided as a helper for some of the transmitter samples. Use a different seed (usually increasing) to generate a different image. Failure can produce a containing the following result code: if the pixel type is not supported. Releases an attached memory buffer. Does nothing other than resetting the memory buffer pointer to NULL. See Attach( System::Byte, UInt32, UInt32, PvPixelType ). The buffer's location in memory. Attach this PvImage to an external memory buffer. This method is identical to , with the following exceptions: This method uses an external memory buffer, controlled by the caller. A pointer to the buffer. See . See . See . See . See . Failure can produce a containing the following result code: Attach this PvImage to an external memory buffer. This method is identical to , with the following exceptions: This method uses an external memory buffer, controlled by the caller. There is one overload for this method, refer to the other overload method: Attach( System::Byte *aRawBuffer, UInt32 aSizeX, UInt32 aSizeY, PvPixelType aPixelType, UInt16 aPaddingX, UInt16 aPaddingY ). A pointer to the buffer. See . See . See . Failure can produce a containing the following result code: Frees (de-allocates) the buffer's internal memory. See also . Allocates memory for this PvImage. Allocs a PvImage of specific width, height and pixel format. The width of the image, in pixels. See property . The height of the image, in pixels. See property . The GEV pixel type from which the pixel depth is extracted. For supported pixel types, see PvPixelType.h. The horizontal padding of the image, in pixels. See property . The vertical padding of the image, in pixels. See property . Failure can produce a containing the following result code: Allocates memory for this PvImage. Allocs a PvImage of specific width, height and pixel format. There is one overload for this method, refer to the other overload method: . The width of the image, in pixels. See property . The height of the image, in pixels. See property . The GEV pixel type from which the pixel depth is extracted. For supported pixel types, see PvPixelType.h. Failure can produce a containing the following result code: Gets the vertical image padding, in bytes. Additional bytes appended at the end of an image. See Gets the horizontal image padding, in bytes; the number of bytes at the end of an image's line that contain meaningless data. Images lines could be grabbed in increments of, let's say, 32 bytes. For an image 511 bytes across, the device adds a meaningless byte to make the line total 512 bytes (divisible by 32). In this case, the paddingX value would be 1 (byte). Other GigE Vision devices may have different requirements on line length. Drivable by 4, 8, 16, etc. or no specific limitations or requirements. Gets the image's vertical offset, in pixels. Gets the image's horizontal offset, in pixels. Gets the effective image size. Uses same size x and y as but excludes all padding. Gets actual image size within the payload or buffer. Uses the GEV leader for the actual width. Uses the GEV trailer for line count which is the actual height. Gets the size of buffer required to hold the acquired image. This attribute is valid if the last image acquisition was successful or if it failed because the buffer was too small. It can be used to re-allocate the acquisition buffers if the acquisition failed because the buffer was too small. The required size is only computed for the last image - based on the number of lines as provided in the GigE Vision streaming protocol trailer. It is possible that with devices outputting images of varying length (like line scan cameras) that the last image required size may be smaller than the maximum possible size. In order to be 100% sure of allocating buffers correctly, you should either hard code the buffer size to known big enough sizes or use the device GenICam GevPayloadSize parameter for dynamic cases. Gets how many bits are required to hold a pixel using the current buffer's pixel type. Gets the GigE Vision pixel type. The pixel depth, color space, and other information are coded into the value. Gets the image's height, in pixels. Gets the image's width in pixels. Gets the buffer's data pointer. Image interface to a PvBuffer. A PvBuffer represents a generic buffer with no specific payload type. If the payload type is image, the user can obtain a reference to a PvImage buffer interface through the PvBuffer.Image attribute. This PvImage reference is owned by the PvBuffer and does not need to be released after use. It is valid as long as the PvBuffer exists.

Accessing image specific data.

 To determinate the payload type and access image specific data: Retrieve the PvPayloadType using the PvBuffer.PayloadType attribute If PvPayloadType is PvPayloadTypeImage, retrieve a PvImage reference from your PvBuffer Access image specific data through a PvImage reference, like , , etc. There is no need to release or delete the PvImage reference. It is valid as long as the PvBuffer exists. The format of the color data for each pixel in the image. Pre GEV 2.0 pixel type. Maps to PvPixelRGB16_Planar. Pre GEV 2.0 pixel type. Maps to PvPixelRGB12_Planar. Pre GEV 2.0 pixel type. Maps to PvPixelRGB10_Planar. Pre GEV 2.0 pixel type. Maps to PvPixelRGB8_Planar. Pre GEV 2.0 pixel type. Maps to PvPixelYUV8_UYV. Pre GEV 2.0 pixel type. Maps to PvPixelYUV422_8. Pre GEV 2.0 pixel type. Maps to PvPixelYUV422_8_UYVY. Pre GEV 2.0 pixel type. Maps to PvPixelYUV411_8_UYYVYY. Pre GEV 2.0 pixel type. Maps to PvPixelRGB10p32. Pre GEV 2.0 pixel type. Maps to PvPixelRGB10V1Packed. Pre GEV 2.0 pixel type. Maps to PvPixelRGB16. Pre GEV 2.0 pixel type. Maps to PixelRGB8. Pre GEV 2.0 pixel type. Maps to PvPixelRGB12. Pre GEV 2.0 pixel type. Maps to PvPixelBGR10. Pre GEV 2.0 pixel type. Maps to PvPixelRGB10. Pre GEV 2.0 pixel type. Maps to PvPixelBGRa8. Pre GEV 2.0 pixel type. Maps to PvPixelRGBa8. Pre GEV 2.0 pixel type. Maps to PvPixelBGR8. Pre GEV 2.0 pixel type. Maps to PixelRGB8. Deprecated displayable pixel type. Now maps to PvPixelRGB8. Deprecated displayable pixel type. Now maps to PvPixelRGBa8. Deprecated displayable pixel type. Now maps to PvPixelBGR8. Deprecated displayable pixel type. Now maps to PvPixelBGRa8. Deprecated displayable pixel type. Now maps to PvPixelRGB565p. Displayable pixel type. Maps to PvPixelRGB565p. Displayable pixel type. Maps to PvPixelBGR8. Windows display (including .NET) and Windows bitmap define RGB as a sequence of bytes, from the lowest byte address to the highest, of BGR. Displayable pixel type. Maps to PvPixelBGRa8. Windows display (including .NET) and Windows bitmap define RGBA as a sequence of bytes, from the lowest byte address to the highest, of BGRA. GigE Vision pixel type. Three planes of R, G and B pixels. Each color component is stored as 16 bits over two bytes. GigE Vision pixel type. Three planes of R, G and B pixels. Each color component is stored as 12 bits over two bytes. GigE Vision pixel type. Three planes of R, G and B pixels. Each color component is stored as 10 bits over two bytes. GigE Vision pixel type. Three planes of R, G and B pixels. Each color component is stored as a byte. GigE Vision pixel type Cb1Y1Y2Cr1Y3Y4 for 4 pixels. ITU-R BT.709 color space. GigE Vision pixel type Cb1Y1Cr1Y2 for 2 pixels. ITU-R BT.709 color space. GigE Vision pixel type Y1Cb1Y2Cr1 for 2 pixels. ITU-R BT.709 color space. GigE Vision pixel type Cb1Y1C41 for 1 pixel. ITU-R BT.709 color space. GigE Vision pixel type Cb1Y1Y2Cr1Y3Y4 for 4 pixels. ITU-R BT.601 color space. GigE Vision pixel type Cb1Y1Cr1Y2 for 2 pixels. ITU-R BT.601 color space. GigE Vision pixel type Y1Cb1Y2Cr1 for 2 pixels. ITU-R BT.601 color space. GigE Vision pixel type Cb1Y1C41 for 1 pixel. ITU-R BT.601 color space. GigE Vision pixel type Cb1Y1Cr1Y2 for 2 pixels. Default (host JPG) color space. GigE Vision pixel type Y1Cb1Y1Cr1 for 2 pixels. Default (host JPG) color space. GigE Vision pixel type Y1Cb1Y1Cr1 for 2 pixel2. Default (host JPG) color space. GigE Vision pixel type Cb1Y1Cr1 for 1 pixel. Default (host JPG) color space. GigE Vision pixel type U1Y1V1 for 1 pixel. Unspecified color space (default/JPG is used for conversion). GigE Vision pixel type Y1U1Y2V1 for 2 pixels. Unspecified color space (default/JPG is used for conversion). GigE Vision pixel type U1Y1V1Y2 for 2 pixels.space. Unspecified color space (default/JPG is used for conversion). GigE Vision pixel type U1Y1Y2V1Y3Y4 for 4 pixels. Unspecified color space (default/JPG is used for conversion). GigE Vision pixel type B5G6R5. GigE Vision pixel type R5G6B5. GigE Vision pixel type RGB 12 bits per channel packed. The three 10 bits color components are stored on 4.5 bytes. GigE Vision pixel type RGB 10 bits per channel packed. The three 10 bits color components are stored on 4 bytes. GigE Vision pixel type RGB 10 bits per channel packed. The three 10 bits color components are stored on 4 bytes. GigE Vision pixel type RGB 16 bits per channel. GigE Vision pixel BGR 10 bits per channel. Each color component is stored on 2 bytes. GigE Vision pixel type RGB 12 bits per channel. Each color component is stored on 2 bytes. GigE Vision pixel type BGR 10 bits per channel. Each color component is stored on 2 bytes. GigE Vision pixel type RGB 10 bits per channel. Each color component is stored on 2 bytes. GigE Vision pixel type 32 bits, BGRA 8 bits per channel. Reads B-G-R-A from lowest to highest byte address. GigE Vision pixel type 32 bits, RGBA 8 bits per channel. Reads R-G-B-A from lowest to highest byte address. GigE Vision pixel type 24 bits, BGR 8 bits per channel. Reads B-G-R from lowest to highest byte address. GigE Vision pixel type 24 bits, RGB 8 bits per channel. Reads R-G-B from lowest to highest byte address. GigE Vision pixel type, Bayer BG pattern 16 stored on two bytes. GigE Vision pixel type, Bayer GB pattern 16 stored on two bytes. GigE Vision pixel type, Bayer RG pattern 16 stored on two bytes. GigE Vision pixel type, Bayer GR pattern 16 stored on two bytes. GigE Vision pixel type, Bayer BG pattern 12 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer GB pattern 12 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer RG pattern 12 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer GR pattern 12 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer BG pattern 10 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer GB pattern 10 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer RG pattern 10 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer GR pattern 10 bits, two pixels stored on two bytes. GigE Vision pixel type, Bayer BG pattern 12 bits stored on two bytes. GigE Vision pixel type, Bayer GB pattern 12 bits stored on two bytes. GigE Vision pixel type, Bayer RG pattern 12 bits stored on two bytes. GigE Vision pixel type, Bayer GR pattern 12 bits stored on two bytes. GigE Vision pixel type, Bayer BG pattern 10 bits stored on two bytes. GigE Vision pixel type, Bayer GB pattern 10 bits stored on two bytes. GigE Vision pixel type, Bayer RG pattern 10 bits stored on two bytes. GigE Vision pixel type, Bayer GR pattern 10 bits stored on two bytes. GigE Vision pixel type, Bayer BG pattern 8 bits. GigE Vision pixel type, Bayer GB pattern 8 bits. GigE Vision pixel type, Bayer RG pattern 8 bits. GigE Vision pixel type, Bayer GR pattern 8 bits. GigE Vision pixel type, monochrome 16 bits stored on two bytes. GigE Vision pixel type, monochrome 16 bits stored on two bytes. GigE Vision pixel type, monochrome 12 bits, two pixels stored in 2 bytes. GigE Vision pixel type, monochrome 12 bits stored in 2 bytes. GigE Vision pixel type, monochrome 10 bits, two pixels stored on three bytes. GigE Vision pixel type, monochrome 10 bits stored in 2 bytes. GigE Vision pixel type, monochrome 8 bits signed. GigE Vision pixel type, monochrome 8 bits unsigned. GigE Vision pixel type, monochrome 4 bits. GigE Vision pixel type, monochrome 2 bits. GigE Vision pixel type, monochrome 1 bit. GVSP payload type. Base value for device specific payload type. Not currently supported. Extended chunk data payload type. Not currently supported. Chunk data payload type. Not currently supported. File payload type. Not currently supported. Raw data payload type. Access from PvBuffer using PvBuffer.RawData. Image payload type. Access from PvBuffer using PvBuffer.Image. Undefined or non initialized payload type. Format type of the buffer. TIFF type Raw type Bitmap type Accessor to the embedded PvResult object. Override of the exception description message. Constructor PvResultCode used to initialize the exception. Error description string. Constructor PvResultCode used to initialize the exception. Constructor PvResult object used to initialize the exception. Exception class wrapping a PvResult object. Used for most of the error management in the eBUS SDK. Destructors Constructor Get the GigE Vision device's network protocol version. The high 16 bits contain the major version and The low 16 bits the minor version. The GigE Vision device's network protocol version. Get the GigE Vision device's subnet mask. The GigE Vision device's subnet mask; the GevCurrentSubnetMask feature. For the form, see . Get the GigE Vision device's default gateway. The GigE Vision device's default gateway; the GevCurrentDefaultGateway feature. For the form, see . Get the GigE Vision device's current IP address. The GigE Vision device's current IP address; the GevCurrentIPAddress feature. The form is a.b.c.d, where a through d are decimal numbers ranging from 0 to 255. Get the GigE Vision device's MAC address. The GigE Vision device's MAC address, in the form aa:bb:cc:dd:ee:ff, where aa through ff are lowercase hexadecimal numbers ranging from 0x00 to 0xff. Information identifying a GigE Vision device. Gets the a string representation of the device info. String representation of the device info. Test if the eBUS SDK license is valid for this device. To connect to third-party GigE Vision devices, the eBUS SDK requires a valid license. If you don't have a license, contact sales. returns true if the license is valid; otherwise; otherwise, false. Test if the device can be reached as currently configured. This method compares the GigE Vision device and NIC's IP configurations to ensure they are on the same subnet. For USB3 Vision devices, the configuration is considered valid if the device can be enumerated and the Pleora driver is associated to the device. True if valid. Gets a reference to (network adapter) through which this GigE Vision device can be reached. Gets a string uniquely identifying this device. Gets a string identifying this device for display purpose. Gets a unique string identifying this GigE Vision device for connection purpose. This string can be used with the factory methods of PvDevice and PvStream to create a GigE Vision device or USB3 Vision device from generic PvDeviceInfo. Gets the GigE Vision device's user defined name. This feature is only supported by devices having persistence memory. It can therefore be blank if not supported by the device, or simply not yet assigned. Gets the GigE Vision device's serial number. Gets the manufacturer information returned by the GigE Vision device. The usage depends on the manufacturer, but may contain an additional model number. GigE Vision device's version. The GenICam DeviceVersion feature. The usage depends on the manufacturer, but may contain a modifier for the model, such as "rev A", "1.0". Gets the GigE Vision device's model name. Gets the GigE Vision device's manufacturer name. Returns the type of the device info object. Get the device class. The device's class; a enumeration. Finalizer. Finalizer. Information about a GigE Vision device. PvDeviceInfo provides information about a GigE Vision device as found by either / or PvDeviceFinderWnd. To use PvDeviceInfo, see . Device information type. U3V device information type. USB device information type. Pleora protocol device information type. GEV device information type. GigE Vision device access type. Exclusive access. The controller has full read-write access and any other requests but discovery or resent packets are denied. Can be used with PvDevice.Connect when requesting read-only access to a device currently on PvAccessOpen or PvAccessControl. Shared access; a main controller has read-write access to the device and any other PvDevice can have read-only access to the device. Open access; the GigE Vision device isn't connected to any other PC. You can't set this value with PvDevice.Connect. Value not known; indeterminate. You can't set this value with PvDevice.Connect. GigE Vision device class. This device is a peripheral. This implies that this device does not have any streaming channels. This device is a transceiver. This implies that one or more streaming channels transmit data and one or more streaming channels receive data. This device is a receiver. This implies all its streaming channels receive data. This device is a transmitter. This implies all its streaming channels transmit data. Device class unknown; indeterminate. Retrieves the internal OS code that may have triggered the error. The user is not expected to be able to interpret this error code, it can widely vary based on the platform or even API that generated it. It can be used in order to provide more information to Pleora support personnel. Returns the internal error code of the error. This method can be used to retrieve the internal error code that was mapped to the public error code contained in the PvResult. The user is not expected to be able to interpret this error code. It can be used in order to provide more information to Pleora support personnel. Test for a successful result. Test for a pending result. Test for a successful result. Test for a failed result. Gets and sets the result description. Gets and sets the result code in the form of a string. Gets and sets the result code. Gets the description of the result code. The description of the result code. Constructor initializing the object to a specific status code. Code to assign to the PvResult object on construction. Description to assign to the PvResult object on construction. Constructor initializing the object to a specific status code. Code to assign to the PvResult object on construction. Result information. The PvResult class provides information about the success or failure of the methods you use. Most successful methods return , however, there are exceptions: Some methods return immediately, but the ultimate success of the method may not be know for some time after (several seconds or more). These methods return . Pending operations are considered successful. To use result codes (best coding practices): Call a method. Test the result for success. Use , , or test against specific PvResult::Code values. The resource is currently available. No more of what was requested is currently available. An error occurred while attempting to perform an operation on a thread like starting, stopping or changing priority. There is no available data to enumerate. A network error occurred while performing the requested operation. There are no more entries to retrieve/enumerate. Some component versions are not compatible. Buffer reception failed. The data receiver entered a state where so many packets and/or blocks were missing that all queued buffers were automatically aborted on an internal reset. Buffer reception failed, consecutive missing buffers higher than allowed. The data receiver may stop attempting to receive a block if a set of consecutive packets exceeding MaximumResendGroupSize. Failure to receive all missing packets for a buffer through resend packets. Too many resend packets were requested, buffer acquisition failure. The buffer was not large enough to hold the payload of the block being received. Call PvBuffer::GetRequiredSize to use the information from the leader packet to determine the size of buffer that would have been required to receive the block. Call PvBuffer::Alloc or PvBuffer::Attach to allocate or associate an a larger area of memory to receive the next block. Some packets are missing in the buffer. Happens when at least one packet of the buffer is missing when it was released back to the calling application. Error with an image. May be returned when a corrupt image arrives due to discontinuities in data between the camera and the hardware responsible for transmitting packets in the GigE Vision device. This can include data overrun, partial and full lines missing. Overflow occurred. Can happen when a counter overflows or when an attempt was made to write past the upper boundary of a file or data structure. A file operation error occurred. The requested feature or functionality is not supported. The requested feature or functionality is not implemented. Can happen when a dynamically selected feature or capability is not implemented in the SDK. The GenICam XML file could not be loaded into GenApi. The file could be corrupted or simply incorrectly structured. Some third-party vendors use XML files that don't conform to the GenApi schema. An eBUS SDK license is missing. To receive data from a GigE Vision device that does not contain a Pleora video interface, a receiver license is required. A license is also required to transmit data using the eBUS SDK using PvTransmitterGEV. When working with images, a watermark is applied when no license is present. This is so that the SDK can be used for evaluation purposes. The operation timed out. The operation exceeded its specified maximum wait time without succeeding. Success. (Pending.) Returned by PvStreamRaw::QueueBuffer to indicate that a buffer has been successfully queued but the operation is still pending (the data has not yet been received). The user closed a dialog and the operation was not performed. This can occur if the "Cancel" button is clicked. A parameter passed to the method is invalid. An undefined error occurred. An operation failed to complete as not enough memory was available. The operation was aborted The data format is not supported for the requested operation. The system's current state doesn't allow the action. The object isn't connected. The file doesn't exist or can't be opened. The expected item wasn't found. An error code hasn't been set. Success. For information about what constitutes success (and the exceptions), see PvResult.