HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UN_DataBuffer< bool > Class Template Reference

Data buffer specialization for boolean (bit) values. More...

#include <UN_DataBuffer.h>

Public Member Functions

 UN_DataBuffer ()=default
 
 UN_DataBuffer (UN_DataSize size)
 
void setData (UN_DataIndex index, bool value)
 Sets the data value for the entry at a given index. More...
 
bool getDataVal (UN_DataIndex index) const
 Returns the data value for the entry at a given index. More...
 
bool operator[] (UN_DataIndex index) const
 
void addData (UN_DataIndex index, bool init_value=false)
 Adds an entry slot to the data buffer. More...
 
void appendData (bool value, exint count)
 Appends count copies of the given value. More...
 
void appendData (const UN_DataBuffer< bool > &src, UN_DataIndex start, UN_DataSize size)
 Appends a span of entries from another buffer. More...
 
void clear ()
 Resets the data to an empty buffer. More...
 
UN_DataSize size () const
 Returns the number of bits held in the data buffer. More...
 
void setCapacityIfNeeded (UN_DataSize min_capacity)
 
bool isValidIndex (UN_DataIndex index) const
 Return true if given index is valid. More...
 

Detailed Description

template<>
class UN_DataBuffer< bool >

Data buffer specialization for boolean (bit) values.

Definition at line 156 of file UN_DataBuffer.h.

Constructor & Destructor Documentation

UN_DataBuffer< bool >::UN_DataBuffer ( )
default
UN_DataBuffer< bool >::UN_DataBuffer ( UN_DataSize  size)
inline

Definition at line 163 of file UN_DataBuffer.h.

Member Function Documentation

void UN_DataBuffer< bool >::addData ( UN_DataIndex  index,
bool  init_value = false 
)
inline

Adds an entry slot to the data buffer.

Definition at line 197 of file UN_DataBuffer.h.

void UN_DataBuffer< bool >::appendData ( bool  value,
exint  count 
)
inline

Appends count copies of the given value.

Definition at line 210 of file UN_DataBuffer.h.

void UN_DataBuffer< bool >::appendData ( const UN_DataBuffer< bool > &  src,
UN_DataIndex  start,
UN_DataSize  size 
)
inline

Appends a span of entries from another buffer.

Definition at line 217 of file UN_DataBuffer.h.

void UN_DataBuffer< bool >::clear ( )
inline

Resets the data to an empty buffer.

Definition at line 229 of file UN_DataBuffer.h.

bool UN_DataBuffer< bool >::getDataVal ( UN_DataIndex  index) const
inline

Returns the data value for the entry at a given index.

Definition at line 181 of file UN_DataBuffer.h.

bool UN_DataBuffer< bool >::isValidIndex ( UN_DataIndex  index) const
inline

Return true if given index is valid.

Definition at line 249 of file UN_DataBuffer.h.

bool UN_DataBuffer< bool >::operator[] ( UN_DataIndex  index) const
inline

Returns the data value for the entry at a given index. Just a convenience operator that calls the official API method.

Definition at line 191 of file UN_DataBuffer.h.

void UN_DataBuffer< bool >::setCapacityIfNeeded ( UN_DataSize  min_capacity)
inline

Definition at line 243 of file UN_DataBuffer.h.

void UN_DataBuffer< bool >::setData ( UN_DataIndex  index,
bool  value 
)
inline

Sets the data value for the entry at a given index.

Definition at line 172 of file UN_DataBuffer.h.

UN_DataSize UN_DataBuffer< bool >::size ( void  ) const
inline

Returns the number of bits held in the data buffer.

Definition at line 236 of file UN_DataBuffer.h.


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