sbfifo(3) [debian man page]
SbFifo(3) Coin SbFifo(3) NAME
SbFifo - A class for managing a pointer first-in, first-out queue. SYNOPSIS
#include <Inventor/threads/SbFifo.h> Public Member Functions void assign (void *ptr, uint32_t type) void retrieve (void *&ptr, uint32_t &type) SbBool tryRetrieve (void *&ptr, uint32_t &type) unsigned int size (void) const void lock (void) const void unlock (void) const SbBool peek (void *&item, uint32_t &type) const SbBool contains (void *item) const SbBool reclaim (void *item) Detailed Description A class for managing a pointer first-in, first-out queue. Member Function Documentation void SbFifo::assign (void *ptr, uint32_ttype) [inline] Puts pointer ptr of type type into the fifo. The type argument is just meant as a user data tag, and a 0 value can be given as the type argument if type data is uninteresting. void SbFifo::retrieve (void *&ptr, uint32_t &type) [inline] Reads a pointer from the queue. Blocks until a pointer is available for reading. SbBool SbFifo::tryRetrieve (void *&ptr, uint32_t &type) [inline] Tries to read a pointer from the queue. If no data can be read, FALSE is returned, and TRUE otherwise. The function does not block. unsigned int SbFifo::size (void) const [inline] Returns number of pointers currently in the queue. void SbFifo::lock (void) const [inline] Blocks until the queue can be locked. void SbFifo::unlock (void) const [inline] Unlocks the queue. SbBool SbFifo::peek (void *&item, uint32_t &type) const [inline] Peeks at the head item of the queue without removing it. In the case where the fifo is empty, FALSE is returned. The queue must be locked with SbFifo::lock() before using this function, then unlocked. SbBool SbFifo::contains (void *item) const [inline] Returns TRUE or FALSE depending on whether the item is in the queue. The queue must be locked with SbFifo::lock() before using this function, then unlocked. SbBool SbFifo::reclaim (void *item) [inline] This function removes the given item from the queue. Returns TRUE or FALSE depending on whether the item was in the queue in the first place. The queue must be locked with SbFifo::lock() before using this function, then unlocked. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SbFifo(3)
Check Out this Related Man Page
SoMFUInt32(3) Coin SoMFUInt32(3) NAME
SoMFUInt32 - The SoMFUInt32 class is a container for 32-bit unsigned integer values. This field is used where nodes, engines or other field containers needs to store a group of multiple 32-bit unsigned integer values. SYNOPSIS
#include <Inventor/fields/SoMFUInt32.h> Inherits SoMField. Public Member Functions virtual SoType getTypeId (void) const virtual void copyFrom (const SoField &field) const SoMFUInt32 & operator= (const SoMFUInt32 &field) virtual SbBool isSame (const SoField &field) const uint32_t operator[] (const int idx) const const uint32_t * getValues (const int start) const int find (uint32_t value, SbBool addifnotfound=FALSE) void setValues (const int start, const int num, const uint32_t *newvals) void set1Value (const int idx, uint32_t value) void setValue (uint32_t value) uint32_t operator= (uint32_t val) SbBool operator== (const SoMFUInt32 &field) const SbBool operator!= (const SoMFUInt32 &field) const uint32_t * startEditing (void) void finishEditing (void) void setValuesPointer (const int num, const uint32_t *userdata) void setValuesPointer (const int num, uint32_t *userdata) Static Public Member Functions static void * createInstance (void) static SoType getClassTypeId (void) static void initClass (void) Protected Member Functions virtual void deleteAllValues (void) virtual void copyValue (int to, int from) virtual int fieldSizeof (void) const virtual void * valuesPtr (void) virtual void setValuesPtr (void *ptr) virtual void allocValues (int num) Protected Attributes uint32_t * values Detailed Description The SoMFUInt32 class is a container for 32-bit unsigned integer values. This field is used where nodes, engines or other field containers needs to store a group of multiple 32-bit unsigned integer values. This field supports application data sharing through a setValuesPointer() method. See SoMField documentation for information on how to use this function. See also: SoSFUInt32 Member Function Documentation SoType SoMFUInt32::getClassTypeId (void) [static] Returns a unique type identifier for this field class. See also: getTypeId(), SoType Reimplemented from SoMField. SoType SoMFUInt32::getTypeId (void) const [virtual] Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. See also: getClassTypeId(), SoType Implements SoField. void SoMFUInt32::copyFrom (const SoField &f) [virtual] Copy value(s) from f into this field. f must be of the same type as this field. Implements SoField. SbBool SoMFUInt32::isSame (const SoField &f) const [virtual] Check for equal type and value(s). Implements SoField. void SoMFUInt32::deleteAllValues (void) [protected], [virtual] This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Implements SoMField. void SoMFUInt32::copyValue (intto, intfrom) [protected], [virtual] This method is used for moving values around internally within a multivalue field. It needs to be overridden in each field so it automatically takes care of running copy contructors where necessary. Implements SoMField. const uint32_t* SoMFUInt32::getValues (const intstart) const [inline] Returns a pointer to the values array. void SoMFUInt32::initClass (void) [static] Internal method called upon initialization of the library (from SoDB::init()) to set up the type system. Reimplemented from SoMField. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoMFUInt32(3)