Beatmup::Chunk Class Reference

Simply a piece of binary data of a specific size. More...

#include <chunkfile.h>

Public Member Functions
	Chunk ()
	Makes an empty chunk. More...
	Chunk (size_t size)
	Allocates a chunk of a given size. More...
	Chunk (ChunkCollection &collection, const std::string &id)
	Reads a chunk from a collection. More...
	~Chunk ()
	Chunk (Chunk &&chunk)
Chunk &	operator= (Chunk &&chunk)
void	writeTo (ChunkFileWriter &file, const std::string &id) const
	Writes a chunk out to a file. More...
size_t	size () const
void *	operator() ()
const void *	operator() () const
	operator bool () const
template<typename datatype >
datatype *	ptr (size_t offset=0)
template<typename datatype >
const datatype *	ptr (size_t offset=0) const
template<typename datatype >
datatype	at (size_t offset) const
template<typename datatype >
datatype &	at (size_t offset)

Private Attributes
size_t	chunkSize
void *	data

Detailed Description

Simply a piece of binary data of a specific size.

A brick in ChunkCollection-based data sets. No information is stored on the nature of the data: it is up to the application to interpret the chunk content.

Definition at line 210 of file chunkfile.h.

Constructor & Destructor Documentation

Chunk() [1/4]

Beatmup::Chunk::Chunk ( )

inline

Makes an empty chunk.

Definition at line 218 of file chunkfile.h.

: chunkSize(0), data(nullptr) {}

Chunk() [2/4]

Chunk::Chunk

(

size_t

size

)

Allocates a chunk of a given size.

Parameters

[in]

size

Chunk size in bytes

Definition at line 153 of file chunkfile.cpp.

                        : chunkSize(size) {
    data = malloc(size);
}

Chunk() [3/4]

Chunk::Chunk	(	ChunkCollection &	collection,
		const std::string &	id
	)

Reads a chunk from a collection.

Parameters

[in]	collection	The collection to read from
[in]	id	The chunk id to find in the collection

Definition at line 158 of file chunkfile.cpp.

                                                            :
    Chunk(collection.chunkSize(id))
{
#ifdef BEATMUP_DEBUG
    DebugAssertion::check(collection.chunkExists(id), "Chunk not found: " + id);
#endif
    collection.fetch(id, data, chunkSize);
}

~Chunk()

Chunk::~Chunk

(

)

Definition at line 173 of file chunkfile.cpp.

              {
    free(data);
}

Chunk() [4/4]

Beatmup::Chunk::Chunk ( Chunk &&  chunk )

inline

Definition at line 235 of file chunkfile.h.

                                   : chunkSize(chunk.chunkSize), data(chunk.data) {
            chunk.data = nullptr;
            chunk.chunkSize = 0;
        }

Member Function Documentation

operator=()

Chunk& Beatmup::Chunk::operator= ( Chunk &&  chunk )

inline

Definition at line 240 of file chunkfile.h.

                                               {
            if (data)
                free(data);
            chunkSize = chunk.chunkSize;
            data = chunk.data;
            chunk.data = nullptr;
            chunk.chunkSize = 0;
            return *this;
        }

writeTo()

void Chunk::writeTo	(	ChunkFileWriter &	file,
		const std::string &	id
	)		const

Writes a chunk out to a file.

Parameters

[in]	file	The file to write to
[in]	id	The chunk id

Definition at line 168 of file chunkfile.cpp.

                                                                    {
    file(id, data, chunkSize);
}

size()

size_t Beatmup::Chunk::size ( ) const

inline

Definition at line 257 of file chunkfile.h.

{ return chunkSize; }

operator()() [1/2]

void* Beatmup::Chunk::operator() ( )

inline

Definition at line 259 of file chunkfile.h.

{ return data; }

operator()() [2/2]

const void* Beatmup::Chunk::operator() ( ) const

inline

Definition at line 260 of file chunkfile.h.

{ return data; }

operator bool()

Beatmup::Chunk::operator bool ( ) const

inline

Definition at line 262 of file chunkfile.h.

{ return data != nullptr; }

ptr() [1/2]

template<typename datatype >

datatype* Beatmup::Chunk::ptr ( size_t  offset = 0 )

inline

Definition at line 264 of file chunkfile.h.

                                                                            {
            return (datatype*)(data) + offset;
        }

ptr() [2/2]

template<typename datatype >

const datatype* Beatmup::Chunk::ptr ( size_t  offset = 0 ) const

inline

Definition at line 267 of file chunkfile.h.

                                                                                        {
            return (datatype*)(data) + offset;
        }

at() [1/2]

template<typename datatype >

datatype Beatmup::Chunk::at ( size_t  offset ) const

inline

Definition at line 271 of file chunkfile.h.

                                                                            {
            return ((datatype*)data)[offset];
        }

at() [2/2]

template<typename datatype >

datatype& Beatmup::Chunk::at ( size_t  offset )

inline

Definition at line 275 of file chunkfile.h.

                                                                       {
            return ((datatype*)data)[offset];
        }

Member Data Documentation

chunkSize

size_t Beatmup::Chunk::chunkSize

private

Definition at line 212 of file chunkfile.h.

data

void* Beatmup::Chunk::data

private

Definition at line 213 of file chunkfile.h.

---

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

• core/utils/chunkfile.h
• core/utils/chunkfile.cpp