FreeFOAM The Cross-Platform CFD Toolkit
objectHit Class Reference

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

#include <OpenFOAM/objectHit.H>


Detailed Description

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

Definition at line 55 of file objectHit.H.

List of all members.

Public Member Functions

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

Friends

bool operator== (const objectHit &a, const objectHit &b)
bool operator!= (const objectHit &a, const objectHit &b)
Ostreamoperator<< (Ostream &os, const objectHit &b)

Constructor & Destructor Documentation

objectHit ( )
inline

Construct null.

Definition at line 71 of file objectHit.H.

objectHit ( const bool  success,
const label &  obj 
)
inline

Construct from components.

Definition at line 78 of file objectHit.H.

objectHit ( Istream is)
inline

Construct from Istream.

Definition at line 85 of file objectHit.H.


Member Function Documentation

bool hit ( ) const
inline

Is there a hit.

Definition at line 95 of file objectHit.H.

Referenced by Foam::operator<<().

label hitObject ( ) const
inline

Return hit object.

Definition at line 101 of file objectHit.H.

Referenced by Foam::operator<<().


Friends And Related Function Documentation

bool operator== ( const objectHit a,
const objectHit b 
)
friend

Definition at line 109 of file objectHit.H.

bool operator!= ( const objectHit a,
const objectHit b 
)
friend

Definition at line 114 of file objectHit.H.

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

Definition at line 122 of file objectHit.H.


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