ContainedObject.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 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.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_CONTAINEDOBJECT_H
#define GAUDIKERNEL_CONTAINEDOBJECT_H
 
// Include files
#include <GaudiKernel/Kernel.h>
#include <GaudiKernel/ObjectContainerBase.h>
#include <GaudiKernel/StreamBuffer.h>
#include <iostream>
 
// Forward declarations
template <class TYPE>
class ObjectVector;
template <class TYPE>
class ObjectList;
 
// Typedefs
typedef ObjectVector<ContainedObject> ContainedObjectVector;
typedef ObjectList<ContainedObject>   ContainedObjectList;
 
// Definition of the CLID for this class
static const CLID CLID_ContainedObject = 190;
 
class GAUDI_API ContainedObject {
 
  friend class ObjectVector<ContainedObject>;
  friend class ObjectList<ContainedObject>;
 
protected:
  ContainedObject() = default;
  ContainedObject( const ContainedObject& ) : ContainedObject() {}
  // cppcheck-suppress operatorEqVarError; see comment above
  ContainedObject& operator=( const ContainedObject& ) { return *this; }
  virtual ~ContainedObject();
 
public:
  virtual const CLID& clID() const { return classID(); }
  static const CLID&  classID() { return CLID_ContainedObject; }
 
  const ObjectContainerBase* parent() const { return m_parent; }
  void setParent( ObjectContainerBase* value ) { m_parent = value; }
 
  virtual long index() const { return m_parent ? m_parent->index( this ) : -1; }
  virtual StreamBuffer& serialize( StreamBuffer& s ) const { return s; }
  virtual StreamBuffer& serialize( StreamBuffer& s ) { return s; }
  virtual std::ostream& fillStream( std::ostream& s ) const { return s; }
  friend std::ostream& operator<<( std::ostream& s, const ContainedObject& obj ) { return obj.fillStream( s ); }
 
private:
  ObjectContainerBase* m_parent = nullptr;
};
 
#endif // GAUDIKERNEL_CONTAINEDOBJECT_H