Classes | Public Member Functions | Friends | List of all members
phaseInterfaceKey Class Reference

Word-pair based class used for keying interface models in hash tables. More...

Inheritance diagram for phaseInterfaceKey:
Inheritance graph
[legend]
Collaboration diagram for phaseInterfaceKey:
Collaboration graph
[legend]

Classes

class  hash
 Hashing class. More...
 

Public Member Functions

 phaseInterfaceKey ()
 Construct null. More...
 
 phaseInterfaceKey (const phaseModel &phase1, const phaseModel &phase2)
 Construct from phases. More...
 
 phaseInterfaceKey (const phaseInterface &interface)
 Construct from phase interface. More...
 
virtual ~phaseInterfaceKey ()
 
- Public Member Functions inherited from Pair< word >
 Pair ()
 Null constructor. More...
 
 Pair (const word &f, const word &s)
 Construct from components. More...
 
 Pair (Istream &is)
 Construct from Istream. More...
 
const word & first () const
 Return first. More...
 
word & first ()
 Return first. More...
 
const word & second () const
 Return second. More...
 
word & second ()
 Return second. More...
 
const word & other (const word &a) const
 Return other. More...
 
word & operator[] (const label i)
 Access an element by index. More...
 
const word & operator[] (const label i) const
 Const-access an element by index. More...
 

Friends

bool operator== (const phaseInterfaceKey &a, const phaseInterfaceKey &b)
 Test if keys are equal. More...
 
bool operator!= (const phaseInterfaceKey &a, const phaseInterfaceKey &b)
 Test if keys are unequal. More...
 
Istream & operator>> (Istream &is, phaseInterfaceKey &key)
 Read from stream. More...
 
Ostream & operator<< (Ostream &os, const phaseInterfaceKey &key)
 Write to stream. More...
 

Additional Inherited Members

- Public Types inherited from Pair< word >
typedef word value_type
 Type of values the pair contains. More...
 
typedef word & reference
 Type that can be used for storing into. More...
 
typedef const word & const_reference
 Type that can be used for storing into. More...
 
- Static Public Member Functions inherited from Pair< word >
static const Pair< word > & null ()
 Return a null pair. More...
 
static label size ()
 Return the size. More...
 
static void checkIndex (const label i)
 Check index i is within valid range (0 ... 1) More...
 
static int compare (const Pair< word > &a, const Pair< word > &b)
 Compare two pairs. Return 0 if they are different, +1 if they are. More...
 

Detailed Description

Word-pair based class used for keying interface models in hash tables.

Source files

Definition at line 61 of file phaseInterfaceKey.H.

Constructor & Destructor Documentation

◆ phaseInterfaceKey() [1/3]

phaseInterfaceKey ( )

Construct null.

Definition at line 36 of file phaseInterfaceKey.C.

◆ phaseInterfaceKey() [2/3]

phaseInterfaceKey ( const phaseModel &  phase1,
const phaseModel &  phase2 
)

Construct from phases.

Definition at line 40 of file phaseInterfaceKey.C.

◆ phaseInterfaceKey() [3/3]

phaseInterfaceKey ( const phaseInterface &  interface)

Construct from phase interface.

Definition at line 54 of file phaseInterfaceKey.C.

◆ ~phaseInterfaceKey()

~phaseInterfaceKey ( )
virtual

Definition at line 62 of file phaseInterfaceKey.C.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const phaseInterfaceKey &  a,
const phaseInterfaceKey &  b 
)
friend

Test if keys are equal.

◆ operator!=

bool operator!= ( const phaseInterfaceKey &  a,
const phaseInterfaceKey &  b 
)
friend

Test if keys are unequal.

◆ operator>>

Istream& operator>> ( Istream &  is,
phaseInterfaceKey &  key 
)
friend

Read from stream.

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const phaseInterfaceKey &  key 
)
friend

Write to stream.

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