Util::MemoryFrame Class Reference

#include <MemoryFrame.h>

List of all members.

Public Member Functions
	MemoryFrame (void *base, unsigned int size)
	MemoryFrame ()
	~MemoryFrame ()
void	fill (unsigned char value)
MemoryFrame	getSubFrame (int from, int size)
MemoryFrame	getSubFrameByLimits (int from, int to)
MemoryFrame	getFrameUpto (const MemoryFrame &upto)
void *	begin () const
void *	end () const
unsigned int	size () const
bool	isInside (void *ptr) const
bool	isEmpty () const
bool	isMultipleOf (unsigned int bytes) const
template<typename T >
bool	isFitFor () const
template<typename T >
bool	isMultipleOf () const
bool	operator== (const MemoryFrame &)
bool	compareBytes (const MemoryFrame &)
void	skip (unsigned int bytes)
template<typename T >
void	skip ()
MemoryFrame	read (int bytes)
void	write (const MemoryFrame &source)
template<typename T >
T &	readAs ()
template<typename T >
void	readTo (T &destination)
template<typename T >
bool	tryReadTo (T &destination) throw ()
template<typename T >
bool	writeAs (const T &storee)
template<typename T >
T &	getAs ()
template<typename T >
T &	offsetAs (int offset)
template<typename T >
T *	offset (int offset=0)
template<typename T >
T *	beginAs ()
template<typename T >
T *	endAs ()
template<typename T >
unsigned int	sizeAs ()
Static Public Member Functions
template<typename T >
static MemoryFrame	from (T &structure)

---

Constructor & Destructor Documentation

Util::MemoryFrame::MemoryFrame	(	void *	base,
		unsigned int	size
	)

Util::MemoryFrame::MemoryFrame

(

)

Here is the caller graph for this function:

Util::MemoryFrame::~MemoryFrame

(

)

---

Member Function Documentation

void * Util::MemoryFrame::begin

(

)

const

Here is the caller graph for this function:

template<typename T >

T* Util::MemoryFrame::beginAs

(

)

[inline]

bool Util::MemoryFrame::compareBytes

(

const MemoryFrame &

that

)

void * Util::MemoryFrame::end

(

)

const

Here is the caller graph for this function:

template<typename T >

T* Util::MemoryFrame::endAs

(

)

[inline]

void Util::MemoryFrame::fill

(

unsigned char

value

)

template<typename T >

static MemoryFrame Util::MemoryFrame::from

(

T &

structure

)

[inline, static]

Here is the call graph for this function:

template<typename T >

T& Util::MemoryFrame::getAs

(

)

[inline]

Here is the caller graph for this function:

MemoryFrame Util::MemoryFrame::getFrameUpto

(

const MemoryFrame &

upto

)

Here is the call graph for this function:

MemoryFrame Util::MemoryFrame::getSubFrame	(	int	from,
		int	size
	)

Here is the call graph for this function:

Here is the caller graph for this function:

MemoryFrame Util::MemoryFrame::getSubFrameByLimits	(	int	from,
		int	to
	)

Here is the call graph for this function:

bool Util::MemoryFrame::isEmpty

(

)

const

template<typename T >

bool Util::MemoryFrame::isFitFor

(

)

const [inline]

bool Util::MemoryFrame::isInside

(

void *

ptr

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool Util::MemoryFrame::isMultipleOf

(

unsigned int

bytes

)

const

template<typename T >

bool Util::MemoryFrame::isMultipleOf

(

)

const [inline]

template<typename T >

T* Util::MemoryFrame::offset

(

int

offset = 0

)

[inline]

Here is the caller graph for this function:

template<typename T >

T& Util::MemoryFrame::offsetAs

(

int

offset

)

[inline]

Here is the call graph for this function:

bool Util::MemoryFrame::operator==

(

const MemoryFrame &

operand

)

MemoryFrame Util::MemoryFrame::read

(

int

bytes

)

Here is the call graph for this function:

template<typename T >

T& Util::MemoryFrame::readAs

(

)

[inline]

template<typename T >

void Util::MemoryFrame::readTo

(

T &

destination

)

[inline]

Here is the call graph for this function:

unsigned int Util::MemoryFrame::size

(

)

const

Here is the caller graph for this function:

template<typename T >

unsigned int Util::MemoryFrame::sizeAs

(

)

[inline]

void Util::MemoryFrame::skip

(

unsigned int

bytes

)

template<typename T >

void Util::MemoryFrame::skip

(

)

[inline]

Here is the caller graph for this function:

template<typename T >

bool Util::MemoryFrame::tryReadTo

(

T &

destination

)

throw () [inline]

Here is the caller graph for this function:

void Util::MemoryFrame::write

(

const MemoryFrame &

source

)

Here is the call graph for this function:

template<typename T >

bool Util::MemoryFrame::writeAs

(

const T &

storee

)

[inline]

---

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

• trunk/bwapi/Util/Source/Util/MemoryFrame.h
• trunk/bwapi/Util/Source/Util/MemoryFrame.cpp