DotZLib.ChecksumGeneratorBase Class Reference

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

Inheritance diagram for DotZLib.ChecksumGeneratorBase:

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

Protected Attributes
uint	_current
	The value of the current checksum More...

Properties
uint	Value [get]
	Gets the current checksum value More...
Properties inherited from DotZLib.ChecksumGenerator
uint	Value [get]
	Gets the current value of the checksum More...

Detailed Description

Implements the common functionality needed for all ChecksumGenerators

Definition at line 20 of file ChecksumImpl.cs.

Constructor & Destructor Documentation

ChecksumGeneratorBase() [1/2]

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.

        {
            _current = 0;
        }

References DotZLib.ChecksumGeneratorBase._current.

ChecksumGeneratorBase() [2/2]

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.

        {
            _current = initialValue;
        }

References DotZLib.ChecksumGeneratorBase._current.

Member Function Documentation

Reset()

void DotZLib.ChecksumGeneratorBase.Reset ( )

inline

Resets the current checksum to zero

Implements DotZLib.ChecksumGenerator.

Definition at line 48 of file ChecksumImpl.cs.

{ _current = 0; }

References DotZLib.ChecksumGeneratorBase._current.

Update() [1/4]

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.

        {
            Update(data, 0, data.Length);
        }

References DotZLib.ChecksumGeneratorBase.Update().

Update() [2/4]

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.AdlerChecksum, and DotZLib.CRC32Checksum.

Referenced by DotZLib.ChecksumGeneratorBase.Update().

Update() [3/4]

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.

        {
            Update(Encoding.UTF8.GetBytes(data));
        }

References DotZLib.ChecksumGeneratorBase.Update().

Update() [4/4]

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.

        {
            Update(encoding.GetBytes(data));
        }

References cmd_descs_generate.encoding, and DotZLib.ChecksumGeneratorBase.Update().

Member Data Documentation

_current

uint DotZLib.ChecksumGeneratorBase._current

protected

The value of the current checksum

Definition at line 25 of file ChecksumImpl.cs.

Referenced by DotZLib.ChecksumGeneratorBase.ChecksumGeneratorBase(), DotZLib.ChecksumGeneratorBase.Reset(), DotZLib.CRC32Checksum.Update(), and DotZLib.AdlerChecksum.Update().

Property Documentation

Value

uint DotZLib.ChecksumGeneratorBase.Value

get

Gets the current checksum value

Definition at line 53 of file ChecksumImpl.cs.

{ get { return _current; } }

---

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

• subprojects/zlib-1.2.12/contrib/dotzlib/DotZLib/ChecksumImpl.cs