Go to the documentation of this file.
36 #ifndef RC_GENICAM_API_BUFFER
37 #define RC_GENICAM_API_BUFFER
137 void setNodemap(
const std::shared_ptr<GenApi::CNodeMapRef>
nodemap,
const std::string &tltype);
179 void *
getBase(uint32_t part)
const;
187 size_t getSize(uint32_t part)
const;
275 size_t getWidth(uint32_t part)
const;
492 std::shared_ptr<const GenTLWrapper>
gentl;
@ PIXELFORMAT_NAMESPACE_GEV
Buffer & operator=(const Buffer &)
@ PART_DATATYPE_CHUNKDATA
PIXELFORMAT_NAMESPACE_IDS
Pixelformat namespace IDs as taken from GenTL 1.5 definition.
size_t getDeliveredImageHeight(uint32_t part) const
Returns the number of lines that are delivered in this buffer.
uint64_t getChunkLayoutID() const
Returns the chunk layout id, which serves as an indicator that the chunk layout has changed and the a...
size_t getGlobalSize() const
Returns the global size of the buffer.
Main include file for using GenApi with smart pointers.
@ PIXELFORMAT_NAMESPACE_UNKNOWN
@ PAYLOAD_TYPE_DEVICE_SPECIFIC
void setNodemap(const std::shared_ptr< GenApi::CNodeMapRef > nodemap, const std::string &tltype)
Set the device nodemap.
bool getImagePresent(uint32_t part) const
Returns if a 2D, 3D or confidence image is present in the specified part.
The buffer class encapsulates a Genicam buffer that is provided by a stream.
size_t getPartDataType(uint32_t part) const
Returns the data type id of the specified part as defined in PARTDATATYPE_IDS.
size_t getDeliveredChunkPayloadSize() const
Returnes the delivered chung payload size.
PAYLOADTYPE_INFO_IDS
Payload types as taken from GenTL 1.5 definition.
std::string getTLType() const
Returns the type the used transport layer.
std::string getFilename() const
Returns the filename in case the payload contains a file.
void setHandle(void *handle)
Set the buffer handle that this object should manage.
@ PART_DATATYPE_3D_PLANE_QUADPLANAR
The stream class encapsulates a Genicam stream.
uint64_t getTimestampNS() const
Returns the acquisition timestamp of the data in this buffer in ns.
void * getHandle() const
Get internal stream handle.
uint64_t getPartRegionID(uint32_t part) const
Returns the region id of the specified part.
uint32_t getNumberOfParts() const
Returns the number of parts, excluding chunk data.
size_t getYPadding() const
Returns vertical padding of the data in the buffer in bytes.
@ PART_DATATYPE_CONFIDENCE_MAP
void * getUserPtr() const
Returns the private data pointer of the GenTL Consumer.
bool getIsIncomplete() const
Signals if the buffer is incomplete due to an error.
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.
uint64_t getTimestamp() const
Returns the timestamp of the buffer.
@ PART_DATATYPE_2D_PLANE_BIPLANAR
size_t getHeight(uint32_t part) const
Returns the height of the image in pixel.
@ PIXELFORMAT_NAMESPACE_PFNC_32BIT
size_t getPayloadType() const
Returns the payload type according to PAYLOADTYPE_INFO_IDS.
@ PAYLOAD_TYPE_CHUNK_ONLY
uint64_t getFrameID() const
Returns the sequentially incremented number of the frame.
PARTDATATYPE_IDS
Enumeration describing which data type is present in given buffer part as taken from GenTL 1....
@ PIXELFORMAT_NAMESPACE_CUSTOM_ID
size_t getSize(uint32_t part) const
Returns the size of the specified part of the mult-part buffer.
bool getIsAcquiring() const
Signals if the buffer is currently being filled with data.
uint64_t getPartDataPurposeID(uint32_t part) const
Returns the data purpose id of the specified part.
size_t getXOffset(uint32_t part) const
Returns the horizontal offset of the data in the buffer in pixels from the image origin to handle are...
size_t getSizeFilled() const
Returns the number of bytes written into the buffer last time it has been filled.
size_t getYOffset(uint32_t part) const
Returns the vertical offset of the data in the buffer in lines from the image origin to handle areas ...
@ PAYLOAD_TYPE_MULTI_PART
bool isBigEndian() const
Returns if the data is given as big or little endian.
@ PART_DATATYPE_3D_PLANE_TRIPLANAR
Buffer(const std::shared_ptr< const GenTLWrapper > &gentl, Stream *parent)
Constructs a buffer class as wrapper around a buffer handle.
size_t getXPadding(uint32_t part) const
Returns horizontal padding of the data in the buffer in bytes.
@ PIXELFORMAT_NAMESPACE_PFNC_16BIT
std::shared_ptr< const GenTLWrapper > gentl
void * getGlobalBase() const
Returns the global base address of the buffer memory.
std::shared_ptr< GenApi::CChunkAdapter > chunkadapter
size_t getDataSize() const
Returns the size of data intended to the written to the buffer the last time it has been filled.
bool getNewData() const
Returns if the buffer contains new data.
std::shared_ptr< GenApi::CNodeMapRef > nodemap
@ PART_DATATYPE_CUSTOM_ID
@ PART_DATATYPE_3D_PLANE_BIPLANAR
@ PART_DATATYPE_2D_PLANE_QUADPLANAR
@ PAYLOAD_TYPE_CHUNK_DATA
bool getIsQueued() const
Signals if the buffer is associated to the input or output queue.
size_t getWidth(uint32_t part) const
Returns the width of the image in pixel.
Declaration of the CChunkAdapter class.
uint64_t getPartSourceID(uint32_t part) const
Returns the source id of the specified part.
@ PART_DATATYPE_2D_PLANE_TRIPLANAR
@ PIXELFORMAT_NAMESPACE_IIDC
void * getBase(uint32_t part) const
Returns the base address of the specified part of the multi-part buffer.
uint64_t getPixelFormat(uint32_t part) const
Returns the pixel format of the specified part as defined in the PFNC.
uint64_t getPixelFormatNamespace(uint32_t part) const
Returns the pixel format namespace, which preferably should be PIXELFORMAT_NAMESPACE_PFNC_32BIT.
rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:11