Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / foam / primitives / hashes / SHA1 / SHA1Digest.H
blob88a2041978583964124dcfe5d7ce7655a12f438a
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::SHA1Digest
27 Description
28     The SHA1 message digest.
30 SeeAlso
31     Foam::SHA1
33 SourceFiles
34     SHA1Digest.C
36 \*---------------------------------------------------------------------------*/
38 #ifndef SHA1Digest_H
39 #define SHA1Digest_H
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 // Forward declaration of classes
47 class Ostream;
49 // Forward declaration of friend functions and operators
50 class SHA1;
51 class SHA1Digest;
52 Ostream& operator<<(Ostream&, const SHA1Digest&);
55 /*---------------------------------------------------------------------------*\
56                         Class SHA1Digest Declaration
57 \*---------------------------------------------------------------------------*/
59 class SHA1Digest
61 public:
62     friend class SHA1;
64     //- The length of the digest contents
65     static const unsigned length = 20;
67     //- Construct a zero digest
68     SHA1Digest();
70     //- Reset the digest to zero
71     void clear();
73     //- Equality operator
74     bool operator==(const SHA1Digest&) const;
76     //- Inequality operator
77     bool operator!=(const SHA1Digest&) const;
79     friend Ostream& operator<<(Ostream&, const SHA1Digest&);
81 private:
83     //- The digest contents
84     unsigned char v_[length];
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 } // End namespace Foam
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 #endif
96 // ************************************************************************* //