Files
openfoam/src/OpenFOAM/primitives/ints/uint32/uint32.H
Mark Olesen 806b668418 STYLE: two-parameter Foam::name replaced by word::printf (issue #724)
- reduces some ambiguity and clarifies the expected output and
  behaviour.

STYLE: reduce some automatic conversions of char to string
2018-02-08 12:00:54 +01:00

180 lines
4.5 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2014-2016 OpenFOAM Foundation
\\/ M anipulation | Copyright (C) 2016-2017 OpenCFD Ltd.
-------------------------------------------------------------------------------
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_t
Description
32bit unsigned integer
SourceFiles
uint32.C
uint32IO.C
\*---------------------------------------------------------------------------*/
#ifndef uint32_H
#define uint32_H
#include <cstdint>
#include <climits>
#include <cstdlib>
#include "word.H"
#include "pTraits.H"
#include "direction.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class Istream;
class Ostream;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
//- Return a word representation of a uint32
inline word name(const uint32_t val)
{
// No stripping required
return word(std::to_string(val), false);
}
// * * * * * * * * * * * * * * * IOstream Operators * * * * * * * * * * * * //
//- Read uint32_t from stream
uint32_t readUint32(Istream& is);
//- Parse entire buffer as a uint32_t, skipping leading/trailing whitespace.
// \return Parsed value or FatalIOError on any problem
uint32_t readUint32(const char* buf);
//- Parse entire string as a uint32_t, skipping leading/trailing whitespace.
// \return Parsed value or FatalIOError on any problem
inline uint32_t readUint32(const std::string& str)
{
return readUint32(str.c_str());
}
//- Read entire buffer as a uint32_t, skipping leading/trailing whitespace.
// \return True if successful.
bool readUint32(const char* buf, uint32_t& val);
//- Read entire string as a uint32_t, skipping leading/trailing whitespace.
// \return True if successful.
inline bool readUint32(const std::string& str, uint32_t& val)
{
return readUint32(str.c_str(), val);
}
//- Same as readUint32
// \return True if successful.
inline bool read(const char* buf, uint32_t& val)
{
return readUint32(buf, val);
}
//- Same as readUint32
// \return True if successful.
inline bool read(const std::string& str, uint32_t& val)
{
return readUint32(str, val);
}
Istream& operator>>(Istream& is, uint32_t& val);
Ostream& operator<<(Ostream& os, const uint32_t val);
//- Template specialization for pTraits<uint32_t>
template<>
class pTraits<uint32_t>
{
uint32_t p_;
public:
//- Component type
typedef uint32_t cmptType;
// Member constants
//- Dimensionality of space
static const direction dim = 3;
//- Rank of uint32_t is 0
static const direction rank = 0;
//- Number of components in uint32_t is 1
static const direction nComponents = 1;
// Static data members
static const char* const typeName;
static const char* const 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& val);
//- Construct from Istream
pTraits(Istream& is);
// Member Functions
//- Access to the uint32_t value
operator uint32_t() const
{
return p_;
}
//- Access to the uint32_t value
operator uint32_t&()
{
return p_;
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //