Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
Tuple3< Type1, Type2, Type3 > Class Template Reference

A 3-tuple for storing three objects of different types. More...

Classes

class  Hash
 Hashing function class. More...
 

Public Member Functions

 Tuple3 ()
 Null constructor for lists. More...
 
 Tuple3 (const Type1 &f, const Type2 &s, const Type3 &t)
 Construct from components. More...
 
 Tuple3 (Istream &is)
 Construct from Istream. More...
 
const Type1 & first () const
 Return first. More...
 
Type1 & first ()
 Return first. More...
 
const Type2 & second () const
 Return second. More...
 
Type2 & second ()
 Return second. More...
 
const Type3 & third () const
 Return third. More...
 
Type3 & third ()
 Return third. More...
 

Static Public Attributes

static const char *const typeName
 

Friends

Istream & operator>> (Istream &is, Tuple3< Type1, Type2, Type3 > &t3)
 Read Tuple3 from Istream, discarding contents of existing Tuple3. More...
 
Ostream & operator (Ostream &os, const Tuple3< Type1, Type2, Type3 > &t3)
 

Detailed Description

template<class Type1, class Type2, class Type3>
class Foam::Tuple3< Type1, Type2, Type3 >

A 3-tuple for storing three objects of different types.

Definition at line 59 of file Tuple3.H.

Constructor & Destructor Documentation

◆ Tuple3() [1/3]

Tuple3 ( )
inline

Null constructor for lists.

Definition at line 99 of file Tuple3.H.

◆ Tuple3() [2/3]

Tuple3 ( const Type1 &  f,
const Type2 &  s,
const Type3 &  t 
)
inline

Construct from components.

Definition at line 103 of file Tuple3.H.

◆ Tuple3() [3/3]

Tuple3 ( Istream &  is)
inline

Construct from Istream.

Definition at line 111 of file Tuple3.H.

Member Function Documentation

◆ first() [1/2]

const Type1& first ( ) const
inline

Return first.

Definition at line 120 of file Tuple3.H.

Referenced by Tuple3< Type1, Type2, Type3 >::Hash< HashT1, HashT2, HashT3 >::operator()(), Foam::operator==(), and Foam::reverse().

Here is the caller graph for this function:

◆ first() [2/2]

Type1& first ( )
inline

Return first.

Definition at line 126 of file Tuple3.H.

◆ second() [1/2]

const Type2& second ( ) const
inline

Return second.

Definition at line 132 of file Tuple3.H.

Referenced by Tuple3< Type1, Type2, Type3 >::Hash< HashT1, HashT2, HashT3 >::operator()(), Foam::operator==(), and Foam::reverse().

Here is the caller graph for this function:

◆ second() [2/2]

Type2& second ( )
inline

Return second.

Definition at line 138 of file Tuple3.H.

◆ third() [1/2]

const Type3& third ( ) const
inline

Return third.

Definition at line 144 of file Tuple3.H.

Referenced by Tuple3< Type1, Type2, Type3 >::Hash< HashT1, HashT2, HashT3 >::operator()(), Foam::operator==(), and Foam::reverse().

Here is the caller graph for this function:

◆ third() [2/2]

Type3& third ( )
inline

Return third.

Definition at line 150 of file Tuple3.H.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  is,
Tuple3< Type1, Type2, Type3 > &  t3 
)
friend

Read Tuple3 from Istream, discarding contents of existing Tuple3.

Definition at line 230 of file Tuple3.H.

◆ operator

Ostream& operator ( Ostream &  os,
const Tuple3< Type1, Type2, Type3 > &  t3 
)
friend

Member Data Documentation

◆ typeName

const char* const typeName
static

Definition at line 93 of file Tuple3.H.

The documentation for this class was generated from the following file: