uint32.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2014-2015 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Primitive
    uint32
 
Description
    32bit uinteger
 
SourceFiles
    uint32.C
    uint32IO.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef uint32_H
#define uint32_H
 
#define __STDC_LIMIT_MACROS
#include <stdint.h>
#include <climits>
#include <cstdlib>
 
#include "word.H"
#include "pTraits.H"
#include "direction.H"
 
#ifndef UINT32_MIN
#define UINT32_MIN 0
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
class Istream;
class Ostream;
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
//- Return a word representation of an uint32
word name(const uint32_t);
 
// * * * * * * * * * * * * * * * IOstream Operators  * * * * * * * * * * * * //
 
uint32_t readUint32(Istream&);
bool read(const char*, uint32_t&);
Istream& operator>>(Istream&, uint32_t&);
Ostream& operator<<(Ostream&, const uint32_t);
 
//- Template specialization for pTraits<uint32_t>
template<>
class pTraits<uint32_t>
{
    uint32_t p_;
 
public:
 
    //- Component type
    typedef uint32_t cmptType;
 
    // Member constants
 
        enum
        {
            dim = 3,         
            rank = 0,        
            nComponents = 1  
        };
 
 
    // Static data members
 
        static const char* const typeName;
        static const char* componentNames[];
        static const uint32_t zero;
        static const uint32_t one;
        static const uint32_t min;
        static const uint32_t max;
        static const uint32_t rootMax;
        static const uint32_t rootMin;
 
 
    // Constructors
 
        //- Construct from primitive
        explicit pTraits(const uint32_t&);
 
        //- Construct from Istream
        pTraits(Istream&);
 
 
    // Member Functions
 
        //- Access to the uint32_t value
        operator uint32_t() const
        {
            return p_;
        }
 
        //- Access to the uint value
        operator uint32_t&()
        {
            return p_;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //