OpenFOAM logo
Open Source CFD Toolkit

objectHit Class Reference

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 69 of file objectHit.H.

objectHit const bool  success,
const label obj
[inline]
 

Construct from components.

Definition at line 76 of file objectHit.H.

References Foam::readBool(), and Foam::readLabel().

Here is the call graph for this function:

objectHit Istream is  )  [inline]
 

Construct from Istream.

Definition at line 83 of file objectHit.H.


Member Function Documentation

bool hit  )  const [inline]
 

Is there a hit.

Definition at line 93 of file objectHit.H.

References Foam::label.

label hitObject  )  const [inline]
 

Return hit object.

Definition at line 99 of file objectHit.H.

References objectHit::hit_, and objectHit::hitObject_.


Friends And Related Function Documentation

bool operator!= const objectHit a,
const objectHit b
[friend]
 

Definition at line 112 of file objectHit.H.

Ostream& operator<< Ostream os,
const objectHit b
[friend]
 

Definition at line 120 of file objectHit.H.

bool operator== const objectHit a,
const objectHit b
[friend]
 

Definition at line 107 of file objectHit.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org