| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / 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::Keyed | |
| Description | |
| A container with an integer key attached to any item. | |
| The key can useful for sorting. | |
| SourceFiles | |
| KeyedI.H | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| // Forward declaration of friend functions and operators | |
| template<class T> class Keyed; | |
| template<class T> Istream& operator>>(Istream&, Keyed<T>&); | |
| template<class T> Ostream& operator<<(Ostream&, const Keyed<T>&); | |
| /*---------------------------------------------------------------------------*\ | |
| Class Keyed Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| template<class T> | |
| class Keyed | |
| : | |
| public T | |
| { | |
| // Private Data | |
| label key_; | |
| public: | |
| // Static Members | |
| //- Add labels to a list of values | |
| inline static List<Keyed<T>> createList | |
| ( | |
| const List<T>&, | |
| const label key=0 | |
| ); | |
| //- Add labels to a list of values | |
| inline static List<Keyed<T>> createList | |
| ( | |
| const List<T>&, | |
| const labelUList& keys | |
| ); | |
| // Constructors | |
| //- Construct null | |
| inline Keyed(); | |
| //- Construct as a copy of item, with a key | |
| inline Keyed(const T& item, const label key=0); | |
| //- Move constructor transferring the item, with a key | |
| inline Keyed(T&& item, const label key=0); | |
| //- Construct from Istream | |
| inline Keyed(Istream&); | |
| // Member Functions | |
| // Access | |
| //- Return const access to the integer key | |
| inline label key() const; | |
| //- Return non-const access to the integer key | |
| inline label& key(); | |
| // IOstream Operators | |
| friend Istream& operator>> <T>(Istream&, Keyed<T>&); | |
| friend Ostream& operator<< <T>(Ostream&, const Keyed<T>&); | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |