File size: 3,358 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2020 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/>.
Class
Foam::objectHit
Description
This class describes a combination of target object index and success flag.
\*---------------------------------------------------------------------------*/
#ifndef objectHit_H
#define objectHit_H
#include "bool.H"
#include "label.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class objectHit Declaration
\*---------------------------------------------------------------------------*/
class objectHit
{
// Private Data
//- Hit success
bool hit_;
//- Object of hit
label hitObject_;
public:
// Constructors
//- Construct null
objectHit()
:
hit_(false),
hitObject_(-1)
{}
//- Construct from components
objectHit(const bool success, const label obj)
:
hit_(success),
hitObject_(obj)
{}
//- Construct from Istream
objectHit(Istream& is)
:
hit_(readBool(is)),
hitObject_(readLabel(is))
{}
// Member Functions
//- Is there a hit
bool hit() const
{
return hit_;
}
//- Return hit object
label hitObject() const
{
return hitObject_;
}
// Friend Operators
inline friend bool operator==(const objectHit& a, const objectHit& b)
{
return (a.hit_ == b.hit_) && (a.hitObject_ == b.hitObject_);
}
inline friend bool operator!=(const objectHit& a, const objectHit& b)
{
return !(a == b);
}
// Ostream operator
inline friend Ostream& operator<<(Ostream& os, const objectHit& obj)
{
return os << obj.hit() << token::SPACE << obj.hitObject();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|