AppReturnCode.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <Gaudi/Property.h>
#include <GaudiKernel/IProperty.h>
 
namespace Gaudi {
  namespace ReturnCode {
 
    constexpr int Success = 0x00;
 
    constexpr int GenericFailure = 0x01;

    constexpr int FailInput          = 0x02; //< Error opening file
    constexpr int AlgorithmFailure   = 0x03; //<
    constexpr int ScheduledStop      = 0x04; //< Loop terminated because of user request
    constexpr int IncidentFailure    = 0x05; //< Fatal error in Incident handling
    constexpr int UnhandledException = 0x06; //<
    constexpr int CorruptedInput     = 0x10; //< Input file showed a corruption
    constexpr int FinalizationFailure = 0x0b;
    constexpr int SignalOffset = 0x80; //< Offset for signal-related return codes
  }                                    // namespace ReturnCode

  inline StatusCode setAppReturnCode( SmartIF<IProperty>& appmgr, int value, bool force = false ) {
    if ( appmgr ) {
      Gaudi::Property<int> returnCode( "ReturnCode", 0 );
      if ( appmgr->getProperty( &returnCode ).isSuccess() ) {
        if ( returnCode.value() == 0 || force ) {
          returnCode.setValue( value );
          return appmgr->setProperty( returnCode );
        }
        // Consider is a success if we do already have an error code.
        return StatusCode::SUCCESS;
      }
    }
    return StatusCode::FAILURE;
  }

  inline int getAppReturnCode( const SmartIF<IProperty>& appmgr ) {
    if ( appmgr ) {
      Gaudi::Property<int> returnCode( "ReturnCode", 0 );
      if ( appmgr->getProperty( &returnCode ).isSuccess() ) return returnCode.value();
    }
    return 0;
  }
} // namespace Gaudi