zeus::TFingerPrint Class Reference

#include <FingerPrint.h>

Inheritance diagram for zeus::TFingerPrint:

zeus::TZObject zeus::ISerializable zeus::IZUnknown zeus::IZUnknown

List of all members.

Public Member Functions

 TFingerPrint ()
virtual ~TFingerPrint ()
Retval generatePrint (const IString &rKeyName, const IString &rData)
Retval generatePrint (const IString &rKeyName, IByteArray &rArray)
Retval generatePrintFromFile (const IString &rKeyName, const IString &rFileName, Int iMaxSize=2000000)
Retval getFingerPrint (IByteArray &rValue) const
TString getKeyName () const
bool operator== (const TFingerPrint &rInpar) const
bool operator!= (const TFingerPrint &rInpar) const
 SERIAL_STRING (m_strKeyName) virtual Retval MQUALIFIER askForInterface(Uint uiInterfaceID
virtual void MQUALIFIER addRef () const
virtual void MQUALIFIER release () const

Public Attributes

IZUnknown *& rpIface


Detailed Description

This generates a finger print using the one way hash function Whirlpool.

Constructor & Destructor Documentation

zeus::TFingerPrint::TFingerPrint (  ) 

TFingerPrint::~TFingerPrint (  )  [virtual]

Destroys the fingerprint


Member Function Documentation

Retval TFingerPrint::generatePrint ( const IString rKeyName,
const IString rData 
)

Generate a finger print out of a text

Parameters:
rKeyName : Name of the key
rData : String data
Return values:
RET_NOERROR : Finger print generared
RET_INVALID_PARAMETER : arr is NULL
RET_REQUEST_FAILED : Finger print already generated

Retval TFingerPrint::generatePrint ( const IString rKeyName,
IByteArray rArray 
)

Generate a finger print out of an array of data

Parameters:
rKeyName : Name of the key
rArray : Array of data
Return values:
RET_NOERROR : Finger print generared
RET_INVALID_PARAMETER : arr is NULL
RET_REQUEST_FAILED : Finger print already generated

Retval TFingerPrint::generatePrintFromFile ( const IString rKeyName,
const IString rFileName,
Int  iMaxSize = 2000000 
)

Generate a finger print out of file

Parameters:
rKeyName : Name of the key
rFileName : Name of the file
iMaxSize : Maximum size of the file to check. All bytes above this maximum will be ignored.
Return values:
RET_NOERROR : Finger print generared
RET_REQUEST_FAILED : Finger print already generated
RET_INVALID_DATA : Could not access the file

Retval TFingerPrint::getFingerPrint ( IByteArray rValue  )  const

Returns the fingerprint as a byte array

Parameters:
rValue : Return parameter
Return values:
RET_NOERROR : Successfully returned
RET_REQUEST_FAILED : No Finger print has been generated
RET_INVALID_PARAMETER : Invalid parameter received

TString TFingerPrint::getKeyName (  )  const

Returns the name of the finger print

Returns:
key name

bool TFingerPrint::operator== ( const TFingerPrint inpar  )  const

Compares two finger prints to be equal

Parameters:
inpar : Object to check
Return values:
true : Equal
false : different

bool TFingerPrint::operator!= ( const TFingerPrint inpar  )  const

Compares two finger prints to be equal

Parameters:
inpar : Object to check
Return values:
true : Equal
false : different

zeus::TFingerPrint::SERIAL_STRING ( m_strKeyName   ) 

virtual void MQUALIFIER zeus::TFingerPrint::addRef (  )  const [virtual]

See also:
IZUnknown::addRef

Reimplemented from zeus::TZObject.

virtual void MQUALIFIER zeus::TFingerPrint::release (  )  const [virtual]

See also:
IZUnknown::release

Reimplemented from zeus::TZObject.


Member Data Documentation


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


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:33 2009