AppReturnCode.h

Go to the documentation of this file.

#ifndef APPRETURNCODE_H_
#define APPRETURNCODE_H_

#include "GaudiKernel/IProperty.h"
#include "GaudiKernel/Property.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

  }

  inline StatusCode setAppReturnCode(SmartIF<IProperty> &appmgr, int value, bool force = false) {
    if (appmgr) {
      IntegerProperty 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) {
      IntegerProperty returnCode("ReturnCode", 0);
      if (appmgr->getProperty(&returnCode).isSuccess())
        return returnCode.value();
    }
    return 0;
  }
}
#endif /* APPRETURNCODE_H_ */