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

#include <StatusCode.h>

Collaboration diagram for TCS::StatusCode:

Public Types

enum  code_t { FAILURE =0, RECOVERABLE =1, SUCCESS =2 }
 

Public Member Functions

 StatusCode ()
 
 StatusCode (code_t code)
 
code_t getCode () const
 
bool isSuccess () const
 
bool isRecoverable () const
 
bool isFailure ()
 
StatusCode operator|= (const StatusCode &sc)
 
StatusCode operator&= (const StatusCode &sc)
 

Private Attributes

code_t m_status
 

Detailed Description

Definition at line 15 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

Member Enumeration Documentation

◆ code_t

Enumerator
FAILURE 
RECOVERABLE 
SUCCESS 

Definition at line 17 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

17 { FAILURE=0, RECOVERABLE=1, SUCCESS=2 };

Constructor & Destructor Documentation

◆ StatusCode() [1/2]

TCS::StatusCode::StatusCode ( )
inline

Definition at line 19 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

19  :
21  {}

◆ StatusCode() [2/2]

TCS::StatusCode::StatusCode ( code_t  code)
inline

Definition at line 24 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

24  :
25  m_status(code)
26  {}

Member Function Documentation

◆ getCode()

code_t TCS::StatusCode::getCode ( ) const
inline

Definition at line 28 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

28 { return m_status; }

◆ isFailure()

bool TCS::StatusCode::isFailure ( )
inline

Definition at line 38 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

38  {
39  return m_status == FAILURE;
40  }

◆ isRecoverable()

bool TCS::StatusCode::isRecoverable ( ) const
inline

Definition at line 34 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

34  {
35  return m_status == RECOVERABLE;
36  }

◆ isSuccess()

bool TCS::StatusCode::isSuccess ( ) const
inline

Definition at line 30 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

30  {
31  return m_status == SUCCESS;
32  }

◆ operator&=()

StatusCode TCS::StatusCode::operator&= ( const StatusCode sc)
inline

Definition at line 46 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

46  {
47  return (sc.getCode()<m_status)?StatusCode(sc.getCode()):StatusCode(m_status); // min of this and sc (any FAILURE is FAILURE)
48  }

◆ operator|=()

StatusCode TCS::StatusCode::operator|= ( const StatusCode sc)
inline

Definition at line 42 of file Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h.

42  {
43  return (sc.getCode()>m_status)?StatusCode(sc.getCode()):StatusCode(m_status); // max of this and sc (any SUCCESS is SUCCESS)
44  }

Member Data Documentation

◆ m_status

code_t TCS::StatusCode::m_status
private

The documentation for this class was generated from the following file:
TCS::StatusCode::SUCCESS
@ SUCCESS
Definition: Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h:17
TCS::StatusCode::FAILURE
@ FAILURE
Definition: Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h:17
AthenaPoolTestRead.sc
sc
Definition: AthenaPoolTestRead.py:27
TCS::StatusCode::m_status
code_t m_status
Definition: Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h:51
histSizes.code
code
Definition: histSizes.py:129
TCS::StatusCode::StatusCode
StatusCode()
Definition: Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h:19
TCS::StatusCode::RECOVERABLE
@ RECOVERABLE
Definition: Trigger/TrigT1/L1Topo/L1TopoCommon/L1TopoCommon/StatusCode.h:17