OpenFOAM logo
Open Source CFD Toolkit

pointIndexHit Class Reference

Collaboration diagram for pointIndexHit:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 pointIndexHit (const bool success, const point &p, const label index)
 Construct from components.
 pointIndexHit (const point &p)
 Construct from point. Hit and distance set later.
 pointIndexHit ()
 Construct null.
bool hit () const
 Is there a hit.
label index () const
 Return index.
const pointhitPoint () const
 Return hit point.
const pointmissPoint () const
 Return miss point.
const pointrawPoint () const
 Return point with no checking.
void setHit ()
void setMiss ()
void setPoint (const point &p)
void setIndex (const label index)
void write (Ostream &os)

Friends

Ostreamoperator<< (Ostream &os, const pointIndexHit &pHit)

Constructor & Destructor Documentation

pointIndexHit const bool  success,
const point p,
const label  index
[inline]
 

Construct from components.

Definition at line 80 of file pointIndexHit.H.

References p, and Foam::point.

pointIndexHit const point p  )  [inline]
 

Construct from point. Hit and distance set later.

Definition at line 88 of file pointIndexHit.H.

References Foam::vector.

pointIndexHit  )  [inline]
 

Construct null.

Definition at line 96 of file pointIndexHit.H.


Member Function Documentation

bool hit  )  const [inline]
 

Is there a hit.

Definition at line 107 of file pointIndexHit.H.

const point& hitPoint  )  const [inline]
 

Return hit point.

Definition at line 119 of file pointIndexHit.H.

label index  )  const [inline]
 

Return index.

Definition at line 113 of file pointIndexHit.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

const point& missPoint  )  const [inline]
 

Return miss point.

Definition at line 132 of file pointIndexHit.H.

const point& rawPoint  )  const [inline]
 

Return point with no checking.

Definition at line 145 of file pointIndexHit.H.

void setHit  )  [inline]
 

Definition at line 150 of file pointIndexHit.H.

void setIndex const label  index  )  [inline]
 

Definition at line 165 of file pointIndexHit.H.

void setMiss  )  [inline]
 

Definition at line 155 of file pointIndexHit.H.

void setPoint const point p  )  [inline]
 

Definition at line 160 of file pointIndexHit.H.

void write Ostream os  )  [inline]
 

Definition at line 170 of file pointIndexHit.H.


Friends And Related Function Documentation

Ostream& operator<< Ostream os,
const pointIndexHit pHit
[friend]
 

Definition at line 182 of file pointIndexHit.H.


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