Utils::HashBuffer Class Reference

An container class for holding a hash buffer. More...

#include <Utils/Hash/HashBuffer.hpp>

Inheritance diagram for Utils::HashBuffer:

Public Member Functions
	HashBuffer (const U8 *args, NATIVE_UINT_TYPE size)
	HashBuffer (const HashBuffer &other)
	HashBuffer ()
virtual	~HashBuffer ()
const HashBuffer &	operator= (const HashBuffer &other)
bool	operator== (const HashBuffer &other) const
bool	operator!= (const HashBuffer &other) const
NATIVE_UINT_TYPE	getBuffCapacity (void) const
U8 *	getBuffAddr (void)
const U8 *	getBuffAddr (void) const
	gets buffer address for data reading, const version More...
Public Member Functions inherited from Fw::SerializeBufferBase
const SerializeBufferBase &	operator= (const SerializeBufferBase &src)
	equal operator More...
virtual	~SerializeBufferBase ()
	destructor More...
SerializeStatus	serialize (U8 val)
	serialize 8-bit unsigned int More...
SerializeStatus	serialize (I8 val)
	serialize 8-bit signed int More...
SerializeStatus	serialize (F32 val)
	serialize 32-bit floating point More...
SerializeStatus	serialize (bool val)
	serialize boolean More...
SerializeStatus	serialize (const void *val)
	serialize pointer (careful, only pointer value, not contents are serialized) More...
SerializeStatus	serialize (const U8 *buff, NATIVE_UINT_TYPE length, bool noLength=false)
	serialize data buffer More...
SerializeStatus	serialize (const SerializeBufferBase &val)
	serialize a serialized buffer More...
SerializeStatus	serialize (const Serializable &val)
	serialize an object derived from serializable base class More...
SerializeStatus	deserialize (U8 &val)
	deserialize 8-bit unsigned int More...
SerializeStatus	deserialize (I8 &val)
	deserialize 8-bit signed int More...
SerializeStatus	deserialize (F32 &val)
	deserialize 32-bit floating point More...
SerializeStatus	deserialize (bool &val)
	deserialize boolean More...
SerializeStatus	deserialize (void *&val)
	deserialize point value (careful, pointer value only, not contents) More...
SerializeStatus	deserialize (U8 *buff, NATIVE_UINT_TYPE &length, bool noLength=false)
	deserialize data buffer More...
SerializeStatus	deserialize (Serializable &val)
	deserialize an object derived from serializable base class More...
SerializeStatus	deserialize (SerializeBufferBase &val)
	serialize a serialized buffer More...
void	resetSer (void)
	reset to beginning of buffer to reuse for serialization More...
void	resetDeser (void)
	reset deserialization to beginning More...
SerializeStatus	deserializeSkip (NATIVE_UINT_TYPE numBytesToSkip)
	Skips the number of specified bytes for deserialization. More...
NATIVE_UINT_TYPE	getBuffLength () const
	returns current buffer size More...
NATIVE_UINT_TYPE	getBuffLeft () const
	returns how much deserialization buffer is left More...
const U8 *	getBuffAddrLeft (void) const
	gets address of remaining non-deserialized data. More...
U8 *	getBuffAddrSer (void)
	gets address of end of serialization. DANGEROUS! Need to know max buffer size and adjust when done More...
SerializeStatus	setBuff (const U8 *src, NATIVE_UINT_TYPE length)
	sets buffer contents and size More...
SerializeStatus	setBuffLen (NATIVE_UINT_TYPE length)
	sets buffer length manually after filling with data More...
SerializeStatus	copyRaw (SerializeBufferBase &dest, NATIVE_UINT_TYPE size)
	directly copies buffer without looking for a size in the stream. More...
SerializeStatus	copyRawOffset (SerializeBufferBase &dest, NATIVE_UINT_TYPE size)
	directly copies buffer without looking for a size in the stream. More...

Additional Inherited Members
Protected Member Functions inherited from Fw::SerializeBufferBase
	SerializeBufferBase ()
	default constructor More...

Detailed Description

An container class for holding a hash buffer.

Definition at line 26 of file HashBuffer.hpp.

Constructor & Destructor Documentation

HashBuffer() [1/3]

Utils::HashBuffer::HashBuffer	(	const U8 *	args,
		NATIVE_UINT_TYPE	size
	)

Construct a HashBuffer object

Definition at line 9 of file HashBufferCommon.cpp.

HashBuffer() [2/3]

Utils::HashBuffer::HashBuffer

(

const HashBuffer &

other

)

Definition at line 17 of file HashBufferCommon.cpp.

HashBuffer() [3/3]

Utils::HashBuffer::HashBuffer

(

)

Definition at line 6 of file HashBufferCommon.cpp.

~HashBuffer()

Utils::HashBuffer::~HashBuffer ( )

virtual

Destroy a HashBuffer object

Definition at line 14 of file HashBufferCommon.cpp.

Member Function Documentation

getBuffAddr() [1/2]

U8 * Utils::HashBuffer::getBuffAddr ( void  )

virtual

Get a pointer to the buffer within the hash buffer

Implements Fw::SerializeBufferBase.

Definition at line 44 of file HashBufferCommon.cpp.

getBuffAddr() [2/2]

const U8 * Utils::HashBuffer::getBuffAddr ( void  ) const

virtual

gets buffer address for data reading, const version

Implements Fw::SerializeBufferBase.

Definition at line 40 of file HashBufferCommon.cpp.

getBuffCapacity()

NATIVE_UINT_TYPE Utils::HashBuffer::getBuffCapacity ( void  ) const

virtual

Get the total buffer length of a hash buffer

Implements Fw::SerializeBufferBase.

Definition at line 48 of file HashBufferCommon.cpp.

operator!=()

bool Utils::HashBuffer::operator!=

(

const HashBuffer &

other

)

const

Compare two hash buffers for inequality

Definition at line 36 of file HashBufferCommon.cpp.

operator=()

const HashBuffer & Utils::HashBuffer::operator=

(

const HashBuffer &

other

)

Assign a hash buffer from another hash buffer

Definition at line 22 of file HashBufferCommon.cpp.

operator==()

bool Utils::HashBuffer::operator==

(

const HashBuffer &

other

)

const

Compare two hash buffers for equality

Definition at line 28 of file HashBufferCommon.cpp.

---

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

• Utils/Hash/HashBuffer.hpp
• Utils/Hash/HashBufferCommon.cpp