|
| Buffer (const std::shared_ptr< const GenTLWrapper > &gentl, Stream *parent) |
| Constructs a buffer class as wrapper around a buffer handle. More...
|
|
void * | getBase (std::uint32_t part) const |
| Returns the base address of the specified part of the multi-part buffer. More...
|
|
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. More...
|
|
bool | getContainsChunkdata () const |
| Returns if the buffer contains chunk data. More...
|
|
bool | getDataLargerThanBuffer () const |
| Signals if the memory that was allocated for this buffer is too small. More...
|
|
size_t | getDataSize () const |
| Returns the size of data intended to the written to the buffer the last time it has been filled. More...
|
|
size_t | getDeliveredChunkPayloadSize () const |
| Returnes the delivered chung payload size. More...
|
|
size_t | getDeliveredImageHeight (std::uint32_t part) const |
| Returns the number of lines that are delivered in this buffer. More...
|
|
std::string | getFilename () const |
| Returns the filename in case the payload contains a file. More...
|
|
uint64_t | getFrameID () const |
| Returns the sequentially incremented number of the frame. More...
|
|
void * | getGlobalBase () const |
| Returns the global base address of the buffer memory. More...
|
|
size_t | getGlobalSize () const |
| Returns the global size of the buffer. More...
|
|
void * | getHandle () const |
| Get internal stream handle. More...
|
|
size_t | getHeight (std::uint32_t part) const |
| Returns the height of the image in pixel. More...
|
|
bool | getImagePresent (std::uint32_t part) const |
| Returns if a 2D, 3D or confidence image is present in the specified part. More...
|
|
bool | getIsAcquiring () const |
| Signals if the buffer is currently being filled with data. More...
|
|
bool | getIsIncomplete () const |
| Signals if the buffer is incomplete due to an error. More...
|
|
bool | getIsQueued () const |
| Signals if the buffer is associated to the input or output queue. More...
|
|
bool | getNewData () const |
| Returns if the buffer contains new data. More...
|
|
std::uint32_t | getNumberOfParts () const |
| Returns the number of parts, excluding chunk data. More...
|
|
size_t | getPartDataType (uint32_t part) const |
| Returns the data type id of the specified part as defined in PARTDATATYPE_IDS. More...
|
|
uint64_t | getPartSourceID (std::uint32_t part) const |
| Returns the source id of the specified part. More...
|
|
size_t | getPayloadType () const |
| Returns the payload type according to PAYLOADTYPE_INFO_IDS. More...
|
|
uint64_t | getPixelFormat (std::uint32_t part) const |
| Returns the pixel format of the specified part as defined in the PFNC. More...
|
|
uint64_t | getPixelFormatNamespace (std::uint32_t part) const |
| Returns the pixel format namespace, which preferably should be PIXELFORMAT_NAMESPACE_PFNC_32BIT. More...
|
|
size_t | getSize (std::uint32_t part) const |
| Returns the size of the specified part of the mult-part buffer. More...
|
|
size_t | getSizeFilled () const |
| Returns the number of bytes written into the buffer last time it has been filled. More...
|
|
uint64_t | getTimestamp () const |
| Returns the timestamp of the buffer. More...
|
|
uint64_t | getTimestampNS () const |
| Returns the acquisition timestamp of the data in this buffer in ns. More...
|
|
std::string | getTLType () const |
| Returns the type the used transport layer. More...
|
|
void * | getUserPtr () const |
| Returns the private data pointer of the GenTL Consumer. More...
|
|
size_t | getWidth (std::uint32_t part) const |
| Returns the width of the image in pixel. More...
|
|
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. More...
|
|
size_t | getXPadding (std::uint32_t part) const |
| Returns horizontal padding of the data in the buffer in bytes. More...
|
|
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. More...
|
|
size_t | getYPadding () const |
| Returns vertical padding of the data in the buffer in bytes. More...
|
|
bool | isBigEndian () const |
| Returns if the data is given as big or little endian. More...
|
|
void | setHandle (void *handle) |
| Set the buffer handle that this object should manage. More...
|
|
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.