CP::CorrectionCode Class Reference

#include <CorrectionCode.h>

List of all members.

Public Types

enum  ErrorCode { Error = 0, OutOfValidityRange = 1, Ok = 2 }
 

Possible values for the correction code.

More...

Public Member Functions

 CorrectionCode (ErrorCode code=Ok)
 Constructor with a correction code.
 CorrectionCode (const CorrectionCode &parent)
 Copy constructor.
 ~CorrectionCode ()
 Destructor.
CorrectionCodeoperator= (const CorrectionCode &rhs)
 Assignment operator.
ErrorCode code () const
 The code stored internally.
 operator ErrorCode () const
 Automatic conversion to the enumeration value.
bool operator< (const CorrectionCode &rhs) const
void setChecked () const
 Mark the correction code as checked, ignoring its value.
void ignore () const
 Ignore the correction code, marking it as checked.

Static Public Member Functions

static void enableFailure ()
 Enable failure (with a backtrace) on an unchecked correction code.
static void disableFailure ()
 Disable failure (no backtrace) on an unchecked correction code.

Detailed Description

Return value from object correction CP tools

This class needs to be used in CP tools implementing object corrections when they implement the interface described in: https://cds.cern.ch/record/1667206 In short, all such CP tools should implement the two following functions:

CorrectionCode Tool::applyCorrection( xAODObjectType& inputObject );
CorrectionCode Tool::correctedCopy( const xAODObjectType& inputObject,
xAODObjectType*& outputObject );

Author:
Nils Krumnack <krumnack@iastate.edu>
Attila Krasznahorkay <Attila.Krasznahorkay@cern.ch>
Revision
719663
Date
2016-01-25 21:27:50 +0100 (Mon, 25 Jan 2016)

Member Enumeration Documentation

Possible values for the correction code.

Enumerator:
Error 

Some error happened during the object correction.

OutOfValidityRange 

Input object is out of validity range.

Ok 

The correction was done successfully.


Member Function Documentation

bool CP::CorrectionCode::operator< ( const CorrectionCode rhs  )  const [inline]

Ordering operator. To make it possible to use this type as an STL container key


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1