A container with an integer key attached to any item.
More...
#include <OpenFOAM/Keyed.H>
Detailed Description
template<class T>
class Foam::Keyed< T >
A container with an integer key attached to any item.
The key can useful for sorting.
- Source files
-
Definition at line 59 of file Keyed.H.
List of all members.
Public Member Functions |
| Keyed () |
| Construct null.
|
| Keyed (const T &item, const label key=0) |
| Construct as a copy of item, with a key.
|
| Keyed (const Xfer< T > &item, const label key=0) |
| Construct by transferring the item, with a key.
|
| Keyed (Istream &) |
| Construct from Istream.
|
label | key () const |
| Return const access to the integer key.
|
label & | key () |
| Return non-const access to the integer key.
|
Constructor & Destructor Documentation
Construct null.
Definition at line 33 of file KeyedI.H.
Keyed |
( |
const T & |
item, |
|
|
const label |
key = 0 |
|
) |
| |
|
inline |
Construct as a copy of item, with a key.
Definition at line 40 of file KeyedI.H.
Keyed |
( |
const Xfer< T > & |
item, |
|
|
const label |
key = 0 |
|
) |
| |
|
inline |
Construct by transferring the item, with a key.
Definition at line 48 of file KeyedI.H.
Member Function Documentation
Foam::label key |
( |
| ) |
const |
|
inline |
Return const access to the integer key.
Definition at line 65 of file KeyedI.H.
Return non-const access to the integer key.
Definition at line 71 of file KeyedI.H.
Friends And Related Function Documentation
The documentation for this class was generated from the following files:
- src/OpenFOAM/containers/Identifiers/Keyed/Keyed.H
- src/OpenFOAM/containers/Identifiers/Keyed/KeyedI.H