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

An objectMap is a pair of labels defining the mapping of an object from another object, e.g. a cell mapped from a point. More...

Public Member Functions

 objectMap () noexcept
 Default construct, with index=-1 and no objects. More...
 
 objectMap (const label index, const labelUList &master)
 Copy construct from components. More...
 
 objectMap (const label index, labelList &&master)
 Move construct from components. More...
 
 objectMap (Istream &is)
 Construct from Istream. More...
 
bool empty () const noexcept
 True if there are no objects. More...
 
label size () const noexcept
 The number of objects. More...
 
label & index () noexcept
 The object index. More...
 
label index () const noexcept
 The object index. More...
 
labelList & masterObjects () noexcept
 The master object indices. More...
 
const labelList & masterObjects () const noexcept
 The master object indices. More...
 

Friends

bool operator== (const objectMap &a, const objectMap &b)
 
bool operator!= (const objectMap &a, const objectMap &b)
 
Ostream & operator<< (Ostream &, const objectMap &)
 
Istream & operator>> (Istream &, objectMap &)
 

Detailed Description

An objectMap is a pair of labels defining the mapping of an object from another object, e.g. a cell mapped from a point.

Source files

Definition at line 56 of file objectMap.H.

Constructor & Destructor Documentation

◆ objectMap() [1/4]

objectMap ( )
inlinenoexcept

Default construct, with index=-1 and no objects.

Definition at line 78 of file objectMap.H.

◆ objectMap() [2/4]

objectMap ( const label  index,
const labelUList &  master 
)
inline

Copy construct from components.

Definition at line 25 of file objectMapI.H.

◆ objectMap() [3/4]

objectMap ( const label  index,
labelList &&  master 
)
inline

Move construct from components.

Definition at line 32 of file objectMapI.H.

◆ objectMap() [4/4]

objectMap ( Istream &  is)
inlineexplicit

Construct from Istream.

Definition at line 39 of file objectMapI.H.

References IOstream::check(), FUNCTION_NAME, Istream::readBegin(), and Istream::readEnd().

Here is the call graph for this function:

Member Function Documentation

◆ empty()

bool empty ( ) const
inlinenoexcept

True if there are no objects.

Definition at line 101 of file objectMap.H.

References UList< T >::empty().

Here is the call graph for this function:

◆ size()

label size ( ) const
inlinenoexcept

The number of objects.

Definition at line 106 of file objectMap.H.

References UList< T >::size().

Here is the call graph for this function:

◆ index() [1/2]

label& index ( )
inlinenoexcept

The object index.

Definition at line 111 of file objectMap.H.

◆ index() [2/2]

label index ( ) const
inlinenoexcept

The object index.

Definition at line 116 of file objectMap.H.

◆ masterObjects() [1/2]

labelList& masterObjects ( )
inlinenoexcept

The master object indices.

Definition at line 121 of file objectMap.H.

◆ masterObjects() [2/2]

const labelList& masterObjects ( ) const
inlinenoexcept

The master object indices.

Definition at line 126 of file objectMap.H.

Friends And Related Function Documentation

◆ operator==

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

◆ operator!=

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

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const objectMap &   
)
friend

◆ operator>>

Istream& operator>> ( Istream &  ,
objectMap &   
)
friend
The documentation for this class was generated from the following files: