kome::core::Buffer Class Reference

memory buffer management class More...

#include <Buffer.h>

Inheritance diagram for kome::core::Buffer:

Collaboration diagram for kome::core::Buffer:

Public Member Functions
	Buffer ()
	constructor
virtual	~Buffer ()
	destructor
void	clear ()
	clears buffer
void *	getBuffer ()
	gets buffer More...
unsigned int	getLength ()
	gets buffer size More...
void	setPosition (const unsigned int pos)
	sets reading position More...
unsigned int	getPosition ()
	gets reading position More...
void	rewind ()
	rewinds reading position
virtual int	write (void *addr, int size)
	writes data (override method) More...
virtual int	read (void *addr, int size)
	reads data (override method) More...
Public Member Functions inherited from kome::core::DataAccessor
	DataAccessor ()
	constructor
virtual	~DataAccessor ()
	destructor

Protected Attributes
std::vector< unsigned char >	m_buffer
unsigned long	m_pos

Detailed Description

memory buffer management class

Definition at line 28 of file Buffer.h.

Member Function Documentation

void * kome::core::Buffer::getBuffer

(

)

gets buffer

Returns

the pointer to the buffer

Definition at line 43 of file Buffer.cpp.

                        {
    if( m_buffer.size() > 0 ) {
        return &( m_buffer[ 0 ] );
    }
    return NULL;
}

unsigned int kome::core::Buffer::getLength

(

)

gets buffer size

Returns

the size of the buffer

Definition at line 51 of file Buffer.cpp.

                               {
    return m_buffer.size();
}

unsigned int kome::core::Buffer::getPosition

(

)

gets reading position

Returns

reading position

Definition at line 61 of file Buffer.cpp.

                                 {
    return m_pos;
}

int kome::core::Buffer::read ( void *  addr, int  size  )

virtual

reads data (override method)

Parameters

[out]	addr	the pointer to store data
[in]	size	read size

Returns

actually reading size

Implements kome::core::DataAccessor.

Definition at line 98 of file Buffer.cpp.

                                       {
    // check the parameters
    if( size <= 0 || addr == NULL ) {
        return 0;
    }

    // size
    int restSize = (int)m_buffer.size() - m_pos;
    if( restSize < size ) {
        size = restSize;
    }
    if( size <= 0 ) {
        return 0;
    }

    // read
    memcpy( addr, &( m_buffer[ m_pos ] ), size );
    m_pos = m_pos + size;

    return size;
}

void kome::core::Buffer::setPosition

(

const unsigned int

pos

)

sets reading position

Parameters

[in]

pos

reading position

Definition at line 56 of file Buffer.cpp.

                                                 {
  m_pos = std::min( pos, (unsigned int)m_buffer.size() );
}

int kome::core::Buffer::write ( void *  addr, int  size  )

virtual

writes data (override method)

Parameters

[in]	addr	the pointer to data
[in]	size	data size

Returns

actually writing size

Implements kome::core::DataAccessor.

Definition at line 71 of file Buffer.cpp.

                                        {
    // check the parameters
    if( size <= 0 || addr == NULL ) {
        return 0;
    }

    // new size
    unsigned long pos = m_buffer.size();
    unsigned long newSize = pos + size;
    if( newSize > m_buffer.max_size() ) {
        newSize = m_buffer.max_size();
    }
    size = newSize - pos;
    if( size <= 0 ) {
        return 0;
    }

    // resize buffer
    m_buffer.resize( newSize );

    // copy data
    memcpy( &( m_buffer[ pos ] ), addr, size );

    return size;
}

Member Data Documentation

std::vector< unsigned char > kome::core::Buffer::m_buffer

protected

buffer

Definition at line 44 of file Buffer.h.

unsigned long kome::core::Buffer::m_pos

protected

position

Definition at line 47 of file Buffer.h.

---

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

• CoreToolkits/Buffer.h
• CoreToolkits/Buffer.cpp