Public Member Functions |
| | Buffer (const std::shared_ptr< const GenTLWrapper > &gentl, Stream *parent) |
| | Constructs a buffer class as wrapper around a buffer handle.
|
| void * | getBase (std::uint32_t part) const |
| | Returns the base address of the specified part of the multi-part buffer.
|
| uint64_t | getChunkLayoutID () const |
| | Returns the chunk layout id, which serves as an indicator that the chunk layout has changed and the application should parse the chunk layout again.
|
| bool | getContainsChunkdata () const |
| | Returns if the buffer contains chunk data.
|
| bool | getDataLargerThanBuffer () const |
| | Signals if the memory that was allocated for this buffer is too small.
|
| size_t | getDataSize () const |
| | Returns the size of data intended to the written to the buffer the last time it has been filled.
|
| size_t | getDeliveredChunkPayloadSize () const |
| | Returnes the delivered chung payload size.
|
| size_t | getDeliveredImageHeight (std::uint32_t part) const |
| | Returns the number of lines that are delivered in this buffer.
|
| std::string | getFilename () const |
| | Returns the filename in case the payload contains a file.
|
| uint64_t | getFrameID () const |
| | Returns the sequentially incremented number of the frame.
|
| void * | getGlobalBase () const |
| | Returns the global base address of the buffer memory.
|
| size_t | getGlobalSize () const |
| | Returns the global size of the buffer.
|
| void * | getHandle () const |
| | Get internal stream handle.
|
| size_t | getHeight (std::uint32_t part) const |
| | Returns the height of the image in pixel.
|
| bool | getImagePresent (std::uint32_t part) const |
| | Returns if a 2D, 3D or confidence image is present in the specified part.
|
| bool | getIsAcquiring () const |
| | Signals if the buffer is currently being filled with data.
|
| bool | getIsIncomplete () const |
| | Signals if the buffer is incomplete due to an error.
|
| bool | getIsQueued () const |
| | Signals if the buffer is associated to the input or output queue.
|
| bool | getNewData () const |
| | Returns if the buffer contains new data.
|
| std::uint32_t | getNumberOfParts () const |
| | Returns the number of parts, excluding chunk data.
|
| size_t | getPartDataType (uint32_t part) const |
| | Returns the data type id of the specified part as defined in PARTDATATYPE_IDS.
|
| uint64_t | getPartSourceID (std::uint32_t part) const |
| | Returns the source id of the specified part.
|
| size_t | getPayloadType () const |
| | Returns the payload type according to PAYLOADTYPE_INFO_IDS.
|
| uint64_t | getPixelFormat (std::uint32_t part) const |
| | Returns the pixel format of the specified part as defined in the PFNC.
|
| uint64_t | getPixelFormatNamespace (std::uint32_t part) const |
| | Returns the pixel format namespace, which preferably should be PIXELFORMAT_NAMESPACE_PFNC_32BIT.
|
| size_t | getSize (std::uint32_t part) const |
| | Returns the size of the specified part of the mult-part buffer.
|
| size_t | getSizeFilled () const |
| | Returns the number of bytes written into the buffer last time it has been filled.
|
| uint64_t | getTimestamp () const |
| | Returns the timestamp of the buffer.
|
| uint64_t | getTimestampNS () const |
| | Returns the acquisition timestamp of the data in this buffer in ns.
|
| std::string | getTLType () const |
| | Returns the type the used transport layer.
|
| void * | getUserPtr () const |
| | Returns the private data pointer of the GenTL Consumer.
|
| size_t | getWidth (std::uint32_t part) const |
| | Returns the width of the image in pixel.
|
| size_t | getXOffset (std::uint32_t part) const |
| | Returns the horizontal offset of the data in the buffer in pixels from the image origin to handle areas of interest.
|
| size_t | getXPadding (std::uint32_t part) const |
| | Returns horizontal padding of the data in the buffer in bytes.
|
| size_t | getYOffset (std::uint32_t part) const |
| | Returns the vertical offset of the data in the buffer in lines from the image origin to handle areas of interest.
|
| size_t | getYPadding () const |
| | Returns vertical padding of the data in the buffer in bytes.
|
| bool | isBigEndian () const |
| | Returns if the data is given as big or little endian.
|
| void | setHandle (void *handle) |
| | Set the buffer handle that this object should manage.
|
Private Member Functions |
| | Buffer (class Buffer &) |
| Buffer & | operator= (const Buffer &) |
Private Attributes |
| void * | buffer |
std::shared_ptr< const
GenTLWrapper > | gentl |
| bool | multipart |
| Stream * | parent |
The buffer class encapsulates a Genicam buffer that is provided by a stream.
A multi-part buffer with one image can be treated like a "normal" buffer.
NOTE: A GenTLException is thrown in case of a severe error.
Definition at line 115 of file buffer.h.