Beatmup::FileInputStream Class Reference

InputStream reading from a file. More...

#include <input_stream.h>

Inheritance diagram for Beatmup::FileInputStream:

Public Member Functions
	FileInputStream ()
	FileInputStream (const char *filename)
bool	isOpen () const
void	open (const char *filename)
void	close ()
void	clear ()
bool	operator() (void *buffer, msize bytes)
	Reads a given number of bytes into a specific memory location. More...
bool	seek (msize pos)
	Moves the read pointer to a given position in the stream. More...
bool	eof () const
	Returns true, if the end of the stream is reached (i.e., all the data is read or the stream is empty). More...

Private Attributes
std::ifstream	stream

Detailed Description

InputStream reading from a file.

Definition at line 54 of file input_stream.h.

Constructor & Destructor Documentation

FileInputStream() [1/2]

FileInputStream::FileInputStream

(

)

Definition at line 24 of file input_stream.cpp.

{}

FileInputStream() [2/2]

Beatmup::FileInputStream::FileInputStream ( const char *  filename )

inline

Definition at line 59 of file input_stream.h.

{ open(filename); }

Member Function Documentation

isOpen()

bool FileInputStream::isOpen

(

)

const

Definition at line 27 of file input_stream.cpp.

                                   {
    return stream.is_open();
}

open()

void FileInputStream::open

(

const char *

filename

)

Definition at line 31 of file input_stream.cpp.

                                               {
    stream.open(filename, std::ios::in | std::ios::binary);
}

close()

void FileInputStream::close

(

)

Definition at line 35 of file input_stream.cpp.

                            {
    stream.close();
}

clear()

void FileInputStream::clear

(

)

Definition at line 39 of file input_stream.cpp.

                            {
    stream.clear();
}

operator()()

bool FileInputStream::operator() ( void *  buffer, msize  bytes  )

virtual

Reads a given number of bytes into a specific memory location.

Parameters

[in]	buffer	The address to store the data to
[in]	bytes	Number of bytes to read

Returns

true on success.

Implements Beatmup::InputStream.

Definition at line 44 of file input_stream.cpp.

                                                          {
    stream.read((char*)buffer, bytes);
    return stream.good();
}

seek()

bool FileInputStream::seek ( msize  pos )

virtual

Moves the read pointer to a given position in the stream.

Parameters

pos	The position in bytes from the beginning of the stream

Returns

true on success.

Implements Beatmup::InputStream.

Definition at line 49 of file input_stream.cpp.

                                    {
    stream.seekg(pos);
    return stream.good();
}

eof()

bool FileInputStream::eof ( ) const

virtual

Returns true, if the end of the stream is reached (i.e., all the data is read or the stream is empty).

Implements Beatmup::InputStream.

Definition at line 54 of file input_stream.cpp.

                                {
    return stream.eof();
}

Member Data Documentation

stream

std::ifstream Beatmup::FileInputStream::stream

private

Definition at line 56 of file input_stream.h.

---

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

• core/utils/input_stream.h
• core/utils/input_stream.cpp