ATLAS Offline Software
Public Types | Public Member Functions | Private Attributes | List of all members
InDetDD::SiIntersect Class Reference

#include <SiIntersect.h>

Collaboration diagram for InDetDD::SiIntersect:

Public Types

enum  IntersectState { OUT = 0, BOUNDARY = 1, IN = 2 }
 

Public Member Functions

 SiIntersect (IntersectState state=OUT)
 
bool in () const
 
bool out () const
 
bool nearBoundary () const
 
bool mayIntersect () const
 
 operator bool () const
 
void setIn ()
 
void setOut ()
 
void setNearBoundary ()
 

Private Attributes

IntersectState m_state
 

Detailed Description

class to run intersection tests

Author
Grant Gorfine

Definition at line 23 of file SiIntersect.h.

Member Enumeration Documentation

◆ IntersectState

Enumerator
OUT 
BOUNDARY 
IN 

Definition at line 27 of file SiIntersect.h.

27 {OUT = 0, BOUNDARY = 1, IN = 2};

Constructor & Destructor Documentation

◆ SiIntersect()

InDetDD::SiIntersect::SiIntersect ( IntersectState  state = OUT)
inline

Definition at line 46 of file SiIntersect.h.

47  : m_state(state)
48 {}

Member Function Documentation

◆ in()

bool InDetDD::SiIntersect::in ( ) const
inline

Definition at line 50 of file SiIntersect.h.

51 {
52  return (m_state == IN);
53 }

◆ mayIntersect()

bool InDetDD::SiIntersect::mayIntersect ( ) const
inline

Definition at line 66 of file SiIntersect.h.

67 {
68  return (m_state == BOUNDARY || m_state == IN);
69 }

◆ nearBoundary()

bool InDetDD::SiIntersect::nearBoundary ( ) const
inline

Definition at line 60 of file SiIntersect.h.

61 {
62  return (m_state == BOUNDARY);
63 }

◆ operator bool()

InDetDD::SiIntersect::operator bool ( ) const
inline

Definition at line 71 of file SiIntersect.h.

72 {
73  return mayIntersect();
74 }

◆ out()

bool InDetDD::SiIntersect::out ( ) const
inline

Definition at line 55 of file SiIntersect.h.

56 {
57  return (m_state == OUT);
58 }

◆ setIn()

void InDetDD::SiIntersect::setIn ( )
inline

Definition at line 76 of file SiIntersect.h.

77 {
78  m_state = IN;
79 }

◆ setNearBoundary()

void InDetDD::SiIntersect::setNearBoundary ( )
inline

Definition at line 86 of file SiIntersect.h.

87 {
88  m_state = BOUNDARY;
89 }

◆ setOut()

void InDetDD::SiIntersect::setOut ( )
inline

Definition at line 81 of file SiIntersect.h.

82 {
83  m_state = OUT;
84 }

Member Data Documentation

◆ m_state

IntersectState InDetDD::SiIntersect::m_state
private

Definition at line 42 of file SiIntersect.h.


The documentation for this class was generated from the following file:
InDetDD::SiIntersect::BOUNDARY
@ BOUNDARY
Definition: SiIntersect.h:27
InDetDD::SiIntersect::IN
@ IN
Definition: SiIntersect.h:27
InDetDD::SiIntersect::m_state
IntersectState m_state
Definition: SiIntersect.h:42
InDetDD::SiIntersect::OUT
@ OUT
Definition: SiIntersect.h:27
InDetDD::SiIntersect::mayIntersect
bool mayIntersect() const
Definition: SiIntersect.h:66