Utils::HashBuffer Class Reference

A 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 ()
HashBuffer &	operator= (const HashBuffer &other)
bool	operator== (const HashBuffer &other) const
bool	operator!= (const HashBuffer &other) const
NATIVE_UINT_TYPE	getBuffCapacity () const
U8 *	getBuffAddr ()
const U8 *	getBuffAddr () const
	gets buffer address for data reading, const version
U32	asBigEndianU32 () const
	Convert bytes 0 through 3 of the hash data to a big-Endian U32 value.
Public Member Functions inherited from Fw::SerializeBufferBase
virtual	~SerializeBufferBase ()
	destructor
SerializeStatus	serialize (U8 val)
	serialize 8-bit unsigned int
SerializeStatus	serialize (I8 val)
	serialize 8-bit signed int
SerializeStatus	serialize (F32 val)
	serialize 32-bit floating point
SerializeStatus	serialize (bool val)
	serialize boolean
SerializeStatus	serialize (const void *val)
	serialize pointer (careful, only pointer value, not contents are serialized)
SerializeStatus	serialize (const U8 *buff, NATIVE_UINT_TYPE length, bool noLength)
	serialize data buffer
SerializeStatus	serialize (const U8 *buff, NATIVE_UINT_TYPE length)
	serialize data buffer
SerializeStatus	serialize (const U8 *buff, FwSizeType length, Serialization::t mode)
	serialize a byte buffer of a given length
SerializeStatus	serialize (const SerializeBufferBase &val)
	serialize a serialized buffer
SerializeStatus	serialize (const Serializable &val)
	serialize an object derived from serializable base class
SerializeStatus	serializeSize (const FwSizeType size)
	serialize a size value
SerializeStatus	deserialize (U8 &val)
	deserialize 8-bit unsigned int
SerializeStatus	deserialize (I8 &val)
	deserialize 8-bit signed int
SerializeStatus	deserialize (F32 &val)
	deserialize 32-bit floating point
SerializeStatus	deserialize (bool &val)
	deserialize boolean
SerializeStatus	deserialize (void *&val)
	deserialize point value (careful, pointer value only, not contents)
SerializeStatus	deserialize (U8 *buff, NATIVE_UINT_TYPE &length, bool noLength)
	deserialize data buffer
SerializeStatus	deserialize (U8 *buff, NATIVE_UINT_TYPE &length)
	deserialize data buffer
SerializeStatus	deserialize (U8 *buff, FwSizeType &length, Serialization::t mode)
	deserialize a byte buffer of a given length
SerializeStatus	deserialize (Serializable &val)
	deserialize an object derived from serializable base class
SerializeStatus	deserialize (SerializeBufferBase &val)
	serialize a serialized buffer
SerializeStatus	deserializeSize (FwSizeType &size)
	deserialize a size value
void	resetSer ()
	reset to beginning of buffer to reuse for serialization
void	resetDeser ()
	reset deserialization to beginning
SerializeStatus	moveSerToOffset (FwSizeType offset)
	Moves serialization to the specified offset.
SerializeStatus	moveDeserToOffset (FwSizeType offset)
	Moves deserialization to the specified offset.
SerializeStatus	serializeSkip (FwSizeType numBytesToSkip)
	Skips the number of specified bytes for serialization.
SerializeStatus	deserializeSkip (FwSizeType numBytesToSkip)
	Skips the number of specified bytes for deserialization.
Serializable::SizeType	getBuffLength () const
	returns current buffer size
Serializable::SizeType	getBuffLeft () const
	returns how much deserialization buffer is left
const U8 *	getBuffAddrLeft () const
	gets address of remaining non-deserialized data.
U8 *	getBuffAddrSer ()
SerializeStatus	setBuff (const U8 *src, Serializable::SizeType length)
	sets buffer contents and size
SerializeStatus	setBuffLen (Serializable::SizeType length)
	sets buffer length manually after filling with data
SerializeStatus	copyRaw (SerializeBufferBase &dest, Serializable::SizeType size)
	directly copies buffer without looking for a size in the stream.
SerializeStatus	copyRawOffset (SerializeBufferBase &dest, Serializable::SizeType size)
	directly copies buffer without looking for a size in the stream.

Additional Inherited Members
Protected Member Functions inherited from Fw::SerializeBufferBase
SerializeBufferBase &	operator= (const SerializeBufferBase &src)
	copy assignment operator
	SerializeBufferBase ()
	default constructor

Detailed Description

A 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 12 of file HashBufferCommon.cpp.

HashBuffer() [2/3]

Utils::HashBuffer::HashBuffer

(

const HashBuffer &

other

)

Definition at line 19 of file HashBufferCommon.cpp.

HashBuffer() [3/3]

Utils::HashBuffer::HashBuffer

(

)

Definition at line 10 of file HashBufferCommon.cpp.

~HashBuffer()

Utils::HashBuffer::~HashBuffer ( )

virtual

Destroy a HashBuffer object

Definition at line 17 of file HashBufferCommon.cpp.

Member Function Documentation

asBigEndianU32()

U32 Utils::HashBuffer::asBigEndianU32

(

)

const

Convert bytes 0 through 3 of the hash data to a big-Endian U32 value.

Definition at line 58 of file HashBufferCommon.cpp.

getBuffAddr() [1/2]

U8 * Utils::HashBuffer::getBuffAddr ( )

virtual

Get a pointer to the buffer within the hash buffer

Implements Fw::SerializeBufferBase.

Definition at line 50 of file HashBufferCommon.cpp.

getBuffAddr() [2/2]

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

virtual

gets buffer address for data reading, const version

Implements Fw::SerializeBufferBase.

Definition at line 46 of file HashBufferCommon.cpp.

getBuffCapacity()

NATIVE_UINT_TYPE Utils::HashBuffer::getBuffCapacity ( ) const

virtual

Get the total buffer length of a hash buffer

Implements Fw::SerializeBufferBase.

Definition at line 54 of file HashBufferCommon.cpp.

operator!=()

bool Utils::HashBuffer::operator!=

(

const HashBuffer &

other

)

const

Compare two hash buffers for inequality

Definition at line 42 of file HashBufferCommon.cpp.

operator=()

HashBuffer & Utils::HashBuffer::operator=

(

const HashBuffer &

other

)

Assign a hash buffer from another hash buffer

Definition at line 24 of file HashBufferCommon.cpp.

operator==()

bool Utils::HashBuffer::operator==

(

const HashBuffer &

other

)

const

Compare two hash buffers for equality

Definition at line 34 of file HashBufferCommon.cpp.

---

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

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