include/GaudiKernel/IInspectable.h

0001 /***********************************************************************************\
0002 * (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
0003 *                                                                                   *
0004 * This software is distributed under the terms of the Apache version 2 licence,     *
0005 * copied verbatim in the file "LICENSE".                                            *
0006 *                                                                                   *
0007 * In applying this licence, CERN does not waive the privileges and immunities       *
0008 * granted to it by virtue of its status as an Intergovernmental Organization        *
0009 * or submit itself to any jurisdiction.                                             *
0010 \***********************************************************************************/
0011 #ifndef GAUDIKERNEL_IINSPECTABLE_H
0012 #define GAUDIKERNEL_IINSPECTABLE_H
0013
0014 // Include Files
0015 #include "GaudiKernel/Kernel.h"
0016
0017 // Forward declaration
0018 class IInspector;
0019 class IInspectable;
0020
0021 /** @class IInspectable IInspectable.h GaudiKernel/IInspectable.h
0022
0023     Interface definition of an inspectable object.
0024     The IInspectable interface must be implemented by all objects that are to be inspected
0025
0026 */
0027 class GAUDI_API IInspectable {
0028 public:
0029   /// destructor
0030   virtual ~IInspectable() = default;
0031
0032   /** return FALSE if doesn't accept Inspecetor so that diagnostic
0033 message can be printed. Calls the inspect member function of
0034 the Inspector on all the members it wants to inspect.
0035 */
0036   virtual bool acceptInspector( IInspector* pI ) = 0;
0037   /** return FALSE if doesn't accept Inspecetor so that diagnostic
0038 message can be printed. Calls the inspect member function of
0039 the Inspector on all the members it wants to inspect.
0040 */
0041   virtual bool acceptInspector( IInspector* pI ) const = 0;
0042 };
0043 #endif // GAUDIKERNEL_IINSPECTABLE_H