kome::core::FileAccessor Class Reference

file accessor class More...

#include <FileAccessor.h>

Inheritance diagram for kome::core::FileAccessor:

Collaboration diagram for kome::core::FileAccessor:

Public Member Functions
	FileAccessor (FILE *fp)
	constructor More...
virtual	~FileAccessor ()
	destructor
FILE *	getFile ()
	gets file descriptor 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
FILE *	m_fp

Detailed Description

file accessor class

Definition at line 26 of file FileAccessor.h.

Constructor & Destructor Documentation

kome::core::FileAccessor::FileAccessor

(

FILE *

fp

)

constructor

Parameters

[in]

fp

file descriptor

Definition at line 28 of file FileAccessor.cpp.

                                     {
    m_fp = fp;
}

Member Function Documentation

FILE * kome::core::FileAccessor::getFile

(

)

gets file descriptor

Returns

file descriptor

Definition at line 37 of file FileAccessor.cpp.

                            {
    return m_fp;
}

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

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

    // read data
    int ret = fread( addr, 1, size, m_fp );

    return ret;
}

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

virtual

writes data (override method)

Parameters

[in]	addr	the pointer to data
	size	data size

Returns

actually writing size

Implements kome::core::DataAccessor.

Definition at line 42 of file FileAccessor.cpp.

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

    // write data
    int ret = fwrite( addr, 1, size, m_fp );

    return ret;
}

Member Data Documentation

FILE* kome::core::FileAccessor::m_fp

protected

file descriptor

Definition at line 43 of file FileAccessor.h.

---

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

• CoreToolkits/FileAccessor.h
• CoreToolkits/FileAccessor.cpp