kome::core::MemoryAccessor Class Reference

memory accessor class More...

#include <MemoryAccessor.h>

Inheritance diagram for kome::core::MemoryAccessor:

Collaboration diagram for kome::core::MemoryAccessor:

Public Member Functions
	MemoryAccessor (void *addr, const unsigned int size)
	constructor More...
virtual	~MemoryAccessor ()
	destructor
void *	getData ()
	gets memory access point More...
unsigned int	getSize ()
	gets data size More...
void	setPosition (const unsigned int pos)
	sets reading postion More...
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
unsigned char *	m_addr
unsigned int	m_size
unsigned int	m_pos

Detailed Description

memory accessor class

Definition at line 26 of file MemoryAccessor.h.

Constructor & Destructor Documentation

kome::core::MemoryAccessor::MemoryAccessor	(	void *	addr,
		const unsigned int	size
	)

constructor

Parameters

[in]	addr	memory access point
[in]	size	data size

Definition at line 28 of file MemoryAccessor.cpp.

                                                                    {
    m_addr = (unsigned char*)addr;
    m_size = size;

    m_pos = 0;
}

Member Function Documentation

void * kome::core::MemoryAccessor::getData

(

)

gets memory access point

Returns

memory access point

Definition at line 40 of file MemoryAccessor.cpp.

                              {
    return m_addr;
}

unsigned int kome::core::MemoryAccessor::getSize

(

)

gets data size

Returns

data size

Definition at line 45 of file MemoryAccessor.cpp.

                                     {
    return m_size;
}

int kome::core::MemoryAccessor::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 75 of file MemoryAccessor.cpp.

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

    // actual size
    int actualSize = std::min( size, (int)m_size - (int)m_pos );
    if( actualSize <= 0 ) {
        return 0;
    }

    // read
    memcpy( addr, m_addr + m_pos, actualSize );
    m_pos += actualSize;

    return actualSize;
}

void kome::core::MemoryAccessor::setPosition

(

const unsigned int

pos

)

sets reading postion

Parameters

[in]

pos

reading position

Definition at line 50 of file MemoryAccessor.cpp.

                                                         {
    m_pos = std::min( pos, m_size );
}

int kome::core::MemoryAccessor::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 55 of file MemoryAccessor.cpp.

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

    // actual size
    int actualSize = std::min( size, (int)m_size - (int)m_pos );
    if( actualSize <= 0 ) {
        return 0;
    }

    // write
    memcpy( m_addr + m_pos, addr, actualSize );
    m_pos += actualSize;

    return actualSize;
}

Member Data Documentation

unsigned char* kome::core::MemoryAccessor::m_addr

protected

memory access point

Definition at line 44 of file MemoryAccessor.h.

unsigned int kome::core::MemoryAccessor::m_pos

protected

reading position

Definition at line 50 of file MemoryAccessor.h.

unsigned int kome::core::MemoryAccessor::m_size

protected

data size

Definition at line 47 of file MemoryAccessor.h.

---

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

• CoreToolkits/MemoryAccessor.h
• CoreToolkits/MemoryAccessor.cpp