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...

Private Attributes
bool	hit_
	Hit success. More...
label	hitObject_
	Object of hit. More...

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

Detailed Description

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

Definition at line 46 of file objectHit.H.

Constructor & Destructor Documentation

objectHit() [1/3]

objectHit ( )

inline

Construct null.

Definition at line 62 of file objectHit.H.

objectHit() [2/3]

objectHit ( const bool  success, const label  obj  )

inline

Construct from components.

Definition at line 69 of file objectHit.H.

objectHit() [3/3]

objectHit ( Istream &  is )

inline

Construct from Istream.

Definition at line 76 of file objectHit.H.

Member Function Documentation

hit()

bool hit ( ) const

inline

Is there a hit.

Definition at line 86 of file objectHit.H.

References objectHit::hit_.

hitObject()

label hitObject ( ) const

inline

Return hit object.

Definition at line 92 of file objectHit.H.

References objectHit::hitObject_.

Friends And Related Function Documentation

operator==

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

friend

Definition at line 100 of file objectHit.H.

operator!=

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

friend

Definition at line 105 of file objectHit.H.

operator<<

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

friend

Definition at line 113 of file objectHit.H.

Field Documentation

hit_

bool hit_

private

Hit success.

Definition at line 51 of file objectHit.H.

Referenced by objectHit::hit().

hitObject_

label hitObject_

private

Object of hit.

Definition at line 54 of file objectHit.H.

Referenced by objectHit::hitObject().

---

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

• src/OpenFOAM/meshes/primitiveShapes/objectHit/objectHit.H