OpenFOAM logo
Open Source CFD Toolkit

pointHit Class Reference

Collaboration diagram for pointHit:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 pointHit (const bool hit, const point &p, const scalar dist, const bool eligibleMiss)
 Construct from components.
 pointHit (const point &p)
 Construct from point. Hit and distance set later.
bool hit () const
 Is there a hit.
const pointhitPoint () const
 Return hit point.
scalar distance () const
 Return distance to hit.
const pointmissPoint () const
 Return miss point.
const pointrawPoint () const
 Return point with no checking.
bool eligibleMiss () const
 Is this an eligible miss.
void setHit ()
void setMiss (const bool eligible)
void setPoint (const point &p)
void setDistance (const scalar d)

Friends

Ostreamoperator<< (Ostream &os, const pointHit &b)

Constructor & Destructor Documentation

pointHit const bool  hit,
const point p,
const scalar  dist,
const bool  eligibleMiss
[inline]
 

Construct from components.

Definition at line 79 of file pointHit.H.

pointHit const point p  )  [inline]
 

Construct from point. Hit and distance set later.

Definition at line 93 of file pointHit.H.


Member Function Documentation

scalar distance  )  const [inline]
 

Return distance to hit.

Definition at line 124 of file pointHit.H.

References FatalErrorIn, and Foam::point.

Referenced by pointHitSort::index(), and pointHit::setDistance().

bool eligibleMiss  )  const [inline]
 

Is this an eligible miss.

Definition at line 149 of file pointHit.H.

bool hit  )  const [inline]
 

Is there a hit.

Definition at line 105 of file pointHit.H.

References FatalErrorIn, and Foam::point.

Referenced by pointHit::setDistance().

const point& hitPoint  )  const [inline]
 

Return hit point.

Definition at line 111 of file pointHit.H.

const point& missPoint  )  const [inline]
 

Return miss point.

Definition at line 130 of file pointHit.H.

const point& rawPoint  )  const [inline]
 

Return point with no checking.

Definition at line 143 of file pointHit.H.

Referenced by pointHit::setDistance().

void setDistance const scalar  d  )  [inline]
 

Definition at line 171 of file pointHit.H.

References pointHit::distance(), pointHit::hit(), and pointHit::rawPoint().

Here is the call graph for this function:

void setHit  )  [inline]
 

Definition at line 154 of file pointHit.H.

void setMiss const bool  eligible  )  [inline]
 

Definition at line 160 of file pointHit.H.

References Foam::point.

void setPoint const point p  )  [inline]
 

Definition at line 166 of file pointHit.H.


Friends And Related Function Documentation

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

Definition at line 179 of file pointHit.H.


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