Public Member Functions | Friends | List of all members
interfaceDefinitions Class Reference

A list of available interface definitions. More...

Inheritance diagram for interfaceDefinitions:
[legend]
Collaboration diagram for interfaceDefinitions:
[legend]

Public Member Functions

 interfaceDefinitions ()
 Null construct. More...
 
label size () const
 Size. More...
 
bool empty () const
 Size. More...
 
void clear ()
 Clear. More...
 
bool add (const interfaceEntry &entry)
 Add (valid) interface entry. More...
 
bool isInterface (label bndId)
 Scan available interface entries for one matching this boundary id. More...
 
word interfaceName (label bndId)
 Scan interface entries for one matching this boundary id. More...
 
- Public Member Functions inherited from Map< interfaceEntry >
 Map ()
 Construct null with default table capacity. More...
 
 Map (const label size)
 Construct with given initial table capacity. More...
 
 Map (Istream &is)
 Construct from Istream with default table capacity. More...
 
 Map (const this_type &map)
 Copy construct. More...
 
 Map (this_type &&map)
 Move construct. More...
 
 Map (std::initializer_list< std::pair< label, interfaceEntry >> map)
 Construct from an initializer list. More...
 
void operator= (const this_type &rhs)
 Copy assignment. More...
 
void operator= (this_type &&rhs)
 Move assignment. More...
 
void operator= (const this_type &rhs)
 Copy assign. More...
 
void operator= (std::initializer_list< std::pair< Key, interfaceEntry >> rhs)
 Copy assign from an initializer list. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 

Friends

Ostream & operator<< (Ostream &os, const interfaceDefinitions &defs)
 

Additional Inherited Members

- Public Types inherited from Map< interfaceEntry >
typedef Map< interfaceEntry > this_type
 The template instance used for this Map. More...
 
typedef HashTable< interfaceEntry, label, Hash< label > > parent_type
 The template instance used for the parent HashTable. More...
 
using iterator = typename parent_type::iterator
 
using const_iterator = typename parent_type::const_iterator
 

Detailed Description

A list of available interface definitions.

Definition at line 175 of file ccmInterfaceDefinitions.H.

Constructor & Destructor Documentation

◆ interfaceDefinitions()

interfaceDefinitions ( )
inline

Null construct.

Definition at line 195 of file ccmInterfaceDefinitions.H.

Member Function Documentation

◆ size()

label size ( ) const
inline

Size.

Definition at line 199 of file ccmInterfaceDefinitions.H.

◆ empty()

bool empty ( ) const
inline

Size.

Definition at line 205 of file ccmInterfaceDefinitions.H.

◆ clear()

void clear ( )
inline

Clear.

Definition at line 211 of file ccmInterfaceDefinitions.H.

◆ add()

bool add ( const interfaceEntry &  entry)
inline

Add (valid) interface entry.

Definition at line 218 of file ccmInterfaceDefinitions.H.

◆ isInterface()

bool isInterface ( label  bndId)
inline

Scan available interface entries for one matching this boundary id.

Definition at line 225 of file ccmInterfaceDefinitions.H.

References forAllConstIters().

Here is the call graph for this function:

◆ interfaceName()

word interfaceName ( label  bndId)
inline

Scan interface entries for one matching this boundary id.

return the canonical name

Definition at line 240 of file ccmInterfaceDefinitions.H.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const interfaceDefinitions &  defs 
)
friend

Definition at line 259 of file ccmInterfaceDefinitions.H.

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