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

This class describes a combination of target object index and success flag. More...

Public Member Functions

 objectHit ()
 Construct null. More...
 
 objectHit (const bool success, const label obj)
 Construct from components. More...
 
 objectHit (Istream &is)
 Construct from Istream. More...
 
bool hit () const
 Is there a hit. More...
 
label hitObject () const
 Return hit object. More...
 
void setHit ()
 
void setMiss ()
 

Friends

Ostream & operator<< (Ostream &os, const objectHit &obj)
 

Detailed Description

This class describes a combination of target object index and success flag.

Definition at line 49 of file objectHit.H.

Constructor & Destructor Documentation

◆ objectHit() [1/3]

objectHit ( )
inline

Construct null.

Definition at line 65 of file objectHit.H.

◆ objectHit() [2/3]

objectHit ( const bool  success,
const label  obj 
)
inline

Construct from components.

Definition at line 72 of file objectHit.H.

◆ objectHit() [3/3]

objectHit ( Istream &  is)
inline

Construct from Istream.

Definition at line 79 of file objectHit.H.

Member Function Documentation

◆ hit()

bool hit ( ) const
inline

Is there a hit.

Definition at line 91 of file objectHit.H.

Referenced by Foam::operator==().

Here is the caller graph for this function:

◆ hitObject()

label hitObject ( ) const
inline

Return hit object.

Definition at line 97 of file objectHit.H.

Referenced by Foam::operator==().

Here is the caller graph for this function:

◆ setHit()

void setHit ( )
inline

Definition at line 105 of file objectHit.H.

◆ setMiss()

void setMiss ( )
inline

Definition at line 110 of file objectHit.H.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const objectHit &  obj 
)
friend

Definition at line 118 of file objectHit.H.

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