DotZLib::ChecksumGeneratorBase Class Reference

Implements the common functionality needed for all ChecksumGenerators. More...

Inherits DotZLib::ChecksumGenerator.

Inherited by DotZLib::AdlerChecksum, and DotZLib::CRC32Checksum.

Inheritance diagram for DotZLib::ChecksumGeneratorBase:

[legend]Collaboration diagram for DotZLib::ChecksumGeneratorBase:

[legend]

Public Member Functions
	ChecksumGeneratorBase ()
	Initializes a new instance of the checksum generator base - the current checksum is set to zero.
	ChecksumGeneratorBase (uint initialValue)
	Initializes a new instance of the checksum generator basewith a specified value.
void	Reset ()
	Resets the current checksum to zero.
abstract void	Update (byte[] data, int offset, int count)
	Updates the current checksum with part of an array of bytes.
void	Update (byte[] data)
	Updates the current checksum with an array of bytes.
void	Update (string data)
	Updates the current checksum with the data from a string.
void	Update (string data, Encoding encoding)
	Updates the current checksum with the data from a string, using a specific encoding.
Protected Attributes
uint	_current
	The value of the current checksum.
Properties
uint	Value
	Gets the current checksum value.

---

Detailed Description

Implements the common functionality needed for all ChecksumGenerators.

Definition at line 20 of file ChecksumImpl.cs.

---

Constructor & Destructor Documentation

DotZLib::ChecksumGeneratorBase::ChecksumGeneratorBase (   )  [inline]

Initializes a new instance of the checksum generator base - the current checksum is set to zero. Definition at line 31 of file ChecksumImpl.cs.

DotZLib::ChecksumGeneratorBase::ChecksumGeneratorBase (  uint  initialValue  )  [inline]

Initializes a new instance of the checksum generator basewith a specified value. Parameters: initialValue  The value to set the current checksum to Definition at line 40 of file ChecksumImpl.cs.

---

Member Function Documentation

void DotZLib::ChecksumGeneratorBase::Reset (   )  [inline]

Resets the current checksum to zero. Implements DotZLib::ChecksumGenerator. Definition at line 48 of file ChecksumImpl.cs.

void DotZLib::ChecksumGeneratorBase::Update (  string  data, Encoding  encoding )  [inline]

Updates the current checksum with the data from a string, using a specific encoding. Parameters: data  The string to update the checksum with encoding  The encoding to use Implements DotZLib::ChecksumGenerator. Definition at line 92 of file ChecksumImpl.cs. References Update().

void DotZLib::ChecksumGeneratorBase::Update (  string  data  )  [inline]

Updates the current checksum with the data from a string. Parameters: data  The string to update the checksum with The characters in the string are converted by the UTF-8 encoding Implements DotZLib::ChecksumGenerator. Definition at line 82 of file ChecksumImpl.cs. References Update().

void DotZLib::ChecksumGeneratorBase::Update (  byte[]  data  )  [inline]

Updates the current checksum with an array of bytes. Parameters: data  The data to update the checksum with Implements DotZLib::ChecksumGenerator. Definition at line 72 of file ChecksumImpl.cs. References Update().

abstract void DotZLib::ChecksumGeneratorBase::Update (  byte[]  data, int  offset, int  count )  [pure virtual]

Updates the current checksum with part of an array of bytes. Parameters: data  The data to update the checksum with offset  Where in data to start updating count  The number of bytes from data to use Exceptions: ArgumentException  The sum of offset and count is larger than the length of data NullReferenceException  data is a null reference ArgumentOutOfRangeException  Offset or count is negative. All the other Update methods are implmeneted in terms of this one. This is therefore the only method a derived class has to implement Implements DotZLib::ChecksumGenerator. Implemented in DotZLib::CRC32Checksum, and DotZLib::AdlerChecksum.

---

Field Documentation

uint DotZLib::ChecksumGeneratorBase::_current [protected]

The value of the current checksum. Definition at line 25 of file ChecksumImpl.cs.

---

Property Documentation

uint DotZLib::ChecksumGeneratorBase::Value [get]

Gets the current checksum value. Implements DotZLib::ChecksumGenerator. Definition at line 53 of file ChecksumImpl.cs. Referenced by DotZLibTests::ChecksumTests::Adler_Data(), and DotZLibTests::ChecksumTests::Adler_Null().

---

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

• lib/zlib-1.2.3/contrib/dotzlib/DotZLib/ChecksumImpl.cs

---