Public Member Functions | Private Member Functions | Private Attributes
rcg::Buffer Class Reference

#include <buffer.h>

List of all members.

Public Member Functions

 Buffer (const std::shared_ptr< const GenTLWrapper > &gentl, Stream *parent)
void * getBase () const
uint64_t getChunkLayoutID () const
bool getContainsChunkdata () const
bool getDataLargerThanBuffer () const
size_t getDataSize () const
size_t getDeliveredChunkPayloadSize () const
size_t getDeliveredImageHeight () const
std::string getFilename () const
uint64_t getFrameID () const
void * getHandle () const
size_t getHeight () const
size_t getImageOffset () const
bool getImagePresent () const
bool getIsAcquiring () const
bool getIsIncomplete () const
bool getIsQueued () const
bool getNewData () const
std::shared_ptr< StreamgetParent () const
size_t getPayloadType () const
uint64_t getPixelFormat () const
uint64_t getPixelFormatNamespace () const
size_t getSize () const
size_t getSizeFilled () const
uint64_t getTimestamp () const
uint64_t getTimestampNS () const
std::string getTLType () const
void * getUserPtr () const
size_t getWidth () const
size_t getXOffset () const
size_t getXPadding () const
size_t getYOffset () const
size_t getYPadding () const
bool isBigEndian () const
void setHandle (void *handle)

Private Member Functions

 Buffer (class Buffer &)
Bufferoperator= (const Buffer &)

Private Attributes

void * buffer
std::shared_ptr< const
GenTLWrapper
gentl
Streamparent

Detailed Description

The buffer class encapsulates a Genicam buffer that is provided by a stream.

NOTE: A GenTLException is thrown in case of a severe error.

Definition at line 91 of file buffer.h.


Constructor & Destructor Documentation

rcg::Buffer::Buffer ( const std::shared_ptr< const GenTLWrapper > &  gentl,
Stream parent 
)

Constructs a buffer class as wrapper around a buffer handle. Buffers must only be constructed by the stream class.

Definition at line 45 of file buffer.cc.

rcg::Buffer::Buffer ( class Buffer ) [private]

Member Function Documentation

void * rcg::Buffer::getBase ( ) const

Returns some information about the buffer.

Returns:
Base address of the buffer memory.

Definition at line 117 of file buffer.cc.

uint64_t rcg::Buffer::getChunkLayoutID ( ) const

Definition at line 245 of file buffer.cc.

Definition at line 321 of file buffer.cc.

Definition at line 315 of file buffer.cc.

size_t rcg::Buffer::getDataSize ( ) const

Definition at line 280 of file buffer.cc.

Definition at line 239 of file buffer.cc.

Definition at line 233 of file buffer.cc.

std::string rcg::Buffer::getFilename ( ) const

Definition at line 251 of file buffer.cc.

uint64_t rcg::Buffer::getFrameID ( ) const

Definition at line 199 of file buffer.cc.

void * rcg::Buffer::getHandle ( ) const

Get internal stream handle.

Returns:
Internal handle.

Definition at line 327 of file buffer.cc.

size_t rcg::Buffer::getHeight ( ) const

Definition at line 174 of file buffer.cc.

size_t rcg::Buffer::getImageOffset ( ) const

Definition at line 209 of file buffer.cc.

Definition at line 204 of file buffer.cc.

Returns some information about the buffer.

Returns:
Flag to indicate that the buffer is currently being filled with data.

Definition at line 148 of file buffer.cc.

Returns some information about the buffer.

Returns:
Flag to indicate that a buffer was filled but an error occurred during that process.

Definition at line 153 of file buffer.cc.

Returns some information about the buffer.

Returns:
Flag to indicate if the buffer is in the input pool or output queue.

Definition at line 143 of file buffer.cc.

Returns some information about the buffer.

Returns:
Flag to indicate that the buffer contains new data since the last call.

Definition at line 138 of file buffer.cc.

std::shared_ptr<Stream> rcg::Buffer::getParent ( ) const

Returns the pointer to the parent stream object.

Returns:
Pointer to parent stream object.
size_t rcg::Buffer::getPayloadType ( ) const

Definition at line 215 of file buffer.cc.

uint64_t rcg::Buffer::getPixelFormat ( ) const

Definition at line 221 of file buffer.cc.

Definition at line 227 of file buffer.cc.

size_t rcg::Buffer::getSize ( ) const

Returns some information about the buffer.

Returns:
Size of the buffer in bytes.

Definition at line 122 of file buffer.cc.

size_t rcg::Buffer::getSizeFilled ( ) const

Returns some information about the buffer.

Returns:
Number of bytes written into the buffer last time it has been filled. This value is reset to 0 when the buffer is placed into the Input Buffer Pool.

Definition at line 163 of file buffer.cc.

uint64_t rcg::Buffer::getTimestamp ( ) const

Returns some information about the buffer.

Returns:
Timestamp the buffer was acquired.

Definition at line 132 of file buffer.cc.

uint64_t rcg::Buffer::getTimestampNS ( ) const

Definition at line 285 of file buffer.cc.

std::string rcg::Buffer::getTLType ( ) const

Returns some information about the buffer.

Returns:
Flag to indicate that a buffer was filled but an error occurred during that process.

Definition at line 158 of file buffer.cc.

void * rcg::Buffer::getUserPtr ( ) const

Returns some information about the buffer.

Returns:
Private data pointer of the GenTL Consumer.

Definition at line 127 of file buffer.cc.

size_t rcg::Buffer::getWidth ( ) const

Definition at line 169 of file buffer.cc.

size_t rcg::Buffer::getXOffset ( ) const

Definition at line 179 of file buffer.cc.

size_t rcg::Buffer::getXPadding ( ) const

Definition at line 189 of file buffer.cc.

size_t rcg::Buffer::getYOffset ( ) const

Definition at line 184 of file buffer.cc.

size_t rcg::Buffer::getYPadding ( ) const

Definition at line 194 of file buffer.cc.

Definition at line 256 of file buffer.cc.

Buffer& rcg::Buffer::operator= ( const Buffer ) [private]
void rcg::Buffer::setHandle ( void *  handle)

Set the buffer handle that this object should manage. The handle is used until a new handle is set.

Definition at line 52 of file buffer.cc.


Member Data Documentation

void* rcg::Buffer::buffer [private]

Definition at line 241 of file buffer.h.

std::shared_ptr<const GenTLWrapper> rcg::Buffer::gentl [private]

Definition at line 240 of file buffer.h.

Definition at line 239 of file buffer.h.


The documentation for this class was generated from the following files:


rc_visard_driver
Author(s): Heiko Hirschmueller , Christian Emmerich , Felix Ruess
autogenerated on Thu Jun 6 2019 20:43:12