gimbal::ByteArray Class Reference

Inheritance diagram for gimbal::ByteArray:

Collaboration diagram for gimbal::ByteArray:

Public Member Functions
	ByteArray (Size bytes=0, const void *pData=nullptr)
	ByteArray (const ByteArray &other)
	ByteArray (ByteArray &&other)
ByteArray &	operator= (const ByteArray &other)
ByteArray &	operator= (ByteArray &&other)
bool	operator== (const ByteArray &rhs) const
bool	operator!= (const ByteArray &rhs) const
Size	getSize (void) const
template<typename T = void*>
T	getData (void) const
bool	isEmpty (void) const
Context *	getContext (void) const
void	clear (void)
void	acquire (std::pair< Size, void * > data)
auto	release (void) -> std::pair< Size, void * >
template<typename T>
void	readData (T *pOutData, Size offset=0, Size bytes=sizeof(T)) const
template<typename T>
void	writeData (const T &pInData, Size offset=0, Size bytes=sizeof(T))
void	resize (Size bytes)
void	grow (Size bytes)
void	shrink (Size bytes)
void	erase (Size offset, Size bytes)
template<typename T>
void	insert (const T &dataIn, Size offset=0, Size bytes=sizeof(T))
template<typename T>
void	append (const T &dataIn, Size bytes=sizeof(T))
template<typename T>
void	prepend (const T &dataIn, Size bytes=sizeof(T))

Additional Inherited Members
Data Fields inherited from GblByteArray
size_t	size
uint8_t *	pData
Related Symbols inherited from GblByteArray
GblByteArray *	GblByteArray_create (size_t size, const void *pData, GblContext *pCtx)
GblByteArray *	GblByteArray_ref (GblByteArray *pSelf)
GblRefCount	GblByteArray_unref (GblByteArray *pSelf)
GBL_RESULT	GblByteArray_copy (GblByteArray *pSelf, const GblByteArray *pOther)
GBL_RESULT	GblByteArray_move (GblByteArray *pSelf, GblByteArray *pOther)
GBL_RESULT	GblByteArray_acquire (GblByteArray *pSelf, size_t bytes, void *pData)
GBL_RESULT	GblByteArray_release (GblByteArray *pSelf, size_t *pSize, void **ppData)
int	GblByteArray_compare (const GblByteArray *pSelf, const GblByteArray *pRhs)
GblBool	GblByteArray_equals (const GblByteArray *pSelf, const GblByteArray *pRhs)
GblRefCount	GblByteArray_refCount (const GblByteArray *pSelf)
GblContext *	GblByteArray_context (const GblByteArray *pSelf)
size_t	GblByteArray_size (const GblByteArray *pSelf)
void *	GblByteArray_data (const GblByteArray *pSelf)
GblBool	GblByteArray_empty (const GblByteArray *pSelf)
GblHash	GblByteArray_hash (const GblByteArray *pSelf)
const char *	GblByteArray_cString (const GblByteArray *pSelf)
GblStringView	GblByteArray_stringView (const GblByteArray *pSelf)
uint8_t	GblByteArray_at (const GblByteArray *pSelf, size_t index)
GBL_RESULT	GblByteArray_read (const GblByteArray *pSelf, size_t offset, size_t bytes, void *pOut)
GBL_RESULT	GblByteArray_write (GblByteArray *pSelf, size_t offset, size_t bytes, const void *pIn)
GBL_RESULT	GblByteArray_set (GblByteArray *pSelf, size_t bytes, const void *pData)
GBL_RESULT	GblByteArray_append (GblByteArray *pSelf, size_t bytes, const void *pData)
GBL_RESULT	GblByteArray_prepend (GblByteArray *pSelf, size_t bytes, const void *pData)
GBL_RESULT	GblByteArray_insert (GblByteArray *pSelf, size_t offset, size_t bytes, const void *pData)
GBL_RESULT	GblByteArray_erase (GblByteArray *pSelf, size_t offset, size_t bytes)
GBL_RESULT	GblByteArray_clear (GblByteArray *pSelf)
GBL_RESULT	GblByteArray_resize (GblByteArray *pSelf, size_t bytes)
GBL_RESULT	GblByteArray_grow (GblByteArray *pSelf, size_t bytes)
GBL_RESULT	GblByteArray_shrink (GblByteArray *pSelf, size_t bytes)

Detailed Description

Definition at line 11 of file gimbal_byte_array.hpp.

Constructor & Destructor Documentation

ByteArray() [1/3]

gimbal::ByteArray::ByteArray ( Size bytes = 0, const void * pData = nullptr )

inline

Definition at line 58 of file gimbal_byte_array.hpp.

                                                         {
    Exception::checkThrow(GblByteArray_construct(this, bytes, pData));
}

ByteArray() [2/3]

gimbal::ByteArray::ByteArray ( const ByteArray & other )

inline

Definition at line 63 of file gimbal_byte_array.hpp.

                                                  {
    Exception::checkThrow(GblByteArray_copy(this, &other));
}

ByteArray() [3/3]

gimbal::ByteArray::ByteArray ( ByteArray && other )

inline

Definition at line 67 of file gimbal_byte_array.hpp.

                                             {
    Exception::checkThrow(GblByteArray_move(this, &other));
}

~ByteArray()

gimbal::ByteArray::~ByteArray ( void )

inline

Definition at line 71 of file gimbal_byte_array.hpp.

                                 {
    Exception::checkThrow(GblByteArray_destruct(this));
}

Member Function Documentation

operator=() [1/2]

ByteArray & gimbal::ByteArray::operator= ( const ByteArray & other )

inline

Definition at line 85 of file gimbal_byte_array.hpp.

                                                             {
    Exception::checkThrow(GblByteArray_copy(this, &other));
    return *this;
}

operator=() [2/2]

ByteArray & gimbal::ByteArray::operator= ( ByteArray && other )

inline

Definition at line 90 of file gimbal_byte_array.hpp.

                                                        {
    Exception::checkThrow(GblByteArray_move(this, &other));
    return *this;
}

operator==()

bool gimbal::ByteArray::operator== ( const ByteArray & rhs ) const

inline

Definition at line 75 of file gimbal_byte_array.hpp.

                                                            {
    GblCmpResult result = GblByteArray_compare(this, &rhs);
    return !result;
}

operator!=()

bool gimbal::ByteArray::operator!= ( const ByteArray & rhs ) const

inline

Definition at line 80 of file gimbal_byte_array.hpp.

                                                            {
    return !(*this == rhs);
}

getSize()

Size gimbal::ByteArray::getSize ( void ) const

inline

Definition at line 95 of file gimbal_byte_array.hpp.

                                         {
    return GblByteArray_size(this);
}

getData()

template<typename T>

T gimbal::ByteArray::getData ( void ) const

inline

Definition at line 100 of file gimbal_byte_array.hpp.

                                      {
    return reinterpret_cast<T>(GblByteArray_data(this));
}

isEmpty()

bool gimbal::ByteArray::isEmpty ( void ) const

inline

Definition at line 104 of file gimbal_byte_array.hpp.

                                         {
    return GblByteArray_isEmpty(this);
}

clear()

void gimbal::ByteArray::clear ( void )

inline

Definition at line 108 of file gimbal_byte_array.hpp.

                                 {
    Exception::checkThrow(GblByteArray_clear(this));
}

acquire()

void gimbal::ByteArray::acquire ( std::pair< Size, void * > data )

inline

Definition at line 112 of file gimbal_byte_array.hpp.

                                                        {
    Exception::checkThrow(GblByteArray_acquire(this, data.first, data.second));
}

release()

auto gimbal::ByteArray::release ( void ) -> std::pair<Size, void*>

inline

Definition at line 116 of file gimbal_byte_array.hpp.

                                                           {
    std::pair<Size, void*> retVal;
    Exception::checkThrow(GblByteArray_release(this, &retVal.first, &retVal.second));
    return retVal;
}

readData()

template<typename T>

void gimbal::ByteArray::readData ( T * pOutData, Size offset = 0, Size bytes = sizeof(T) ) const

inline

Definition at line 153 of file gimbal_byte_array.hpp.

                                                                          {
    Exception::checkThrow(GblByteArray_dataRead(this, offset, bytes, pOutData));
}

writeData()

template<typename T>

void gimbal::ByteArray::writeData ( const T & pInData, Size offset = 0, Size bytes = sizeof(T) )

inline

Definition at line 158 of file gimbal_byte_array.hpp.

                                                                          {
    Exception::checkThrow(GblByteArray_dataWrite(this, offset, bytes, &pInData));
}

resize()

void gimbal::ByteArray::resize ( Size bytes )

inline

Definition at line 122 of file gimbal_byte_array.hpp.

                                        {
    Exception::checkThrow(GblByteArray_resize(this, bytes));
}

grow()

void gimbal::ByteArray::grow ( Size bytes )

inline

Definition at line 126 of file gimbal_byte_array.hpp.

                                      {
    Exception::checkThrow(GblByteArray_grow(this, bytes));
}

shrink()

void gimbal::ByteArray::shrink ( Size bytes )

inline

Definition at line 130 of file gimbal_byte_array.hpp.

                                        {
    Exception::checkThrow(GblByteArray_shrink(this, bytes));
}

erase()

void gimbal::ByteArray::erase ( Size offset, Size bytes )

inline

Definition at line 134 of file gimbal_byte_array.hpp.

                                                    {
    Exception::checkThrow(GblByteArray_erase(this, offset, bytes));
}

insert()

template<typename T>

void gimbal::ByteArray::insert ( const T & dataIn, Size offset = 0, Size bytes = sizeof(T) )

inline

Definition at line 139 of file gimbal_byte_array.hpp.

                                                                      {
    Exception::checkThrow(GblByteArray_insert(this, offset, bytes, &dataIn));
}

append()

template<typename T>

void gimbal::ByteArray::append ( const T & dataIn, Size bytes = sizeof(T) )

inline

Definition at line 144 of file gimbal_byte_array.hpp.

                                                         {
    Exception::checkThrow(GblByteArray_append(this, bytes, &dataIn));
}

prepend()

template<typename T>

void gimbal::ByteArray::prepend ( const T & dataIn, Size bytes = sizeof(T) )

inline

Definition at line 149 of file gimbal_byte_array.hpp.

                                                          {
    Exception::checkThrow(GblByteArray_prepend(this, bytes, &dataIn));
}

---

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

• gimbal_byte_array.hpp