MergedClusterRelations.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_MergedClusterRelations_H
#define EICD_MergedClusterRelations_H
 
#include "eicd/MergedClusterRelationsConst.h"
#include "eicd/MergedClusterRelationsObj.h"
 
#include "eicd/Index.h"
#include <array>
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class MergedClusterRelations
 *  Relational info between a merged cluster and its parents
 *  @author: S. Joosten
 */
class MergedClusterRelations {
 
  friend class MergedClusterRelationsCollection;
  friend class MergedClusterRelationsCollectionIterator;
  friend class ConstMergedClusterRelations;
 
public:
 
  /// default constructor
  MergedClusterRelations();
  MergedClusterRelations(eic::Index clusterID, std::uint32_t size, std::array<eic::Index, 4> parent);
 
  /// constructor from existing MergedClusterRelationsObj
  MergedClusterRelations(MergedClusterRelationsObj* obj);
 
  /// copy constructor
  MergedClusterRelations(const MergedClusterRelations& other);
 
  /// copy-assignment operator
  MergedClusterRelations& operator=(const MergedClusterRelations& other);
 
  /// support cloning (deep-copy)
  MergedClusterRelations clone() const;
 
  /// destructor
  ~MergedClusterRelations();
 
  /// conversion to const object
  operator ConstMergedClusterRelations() const;
 
public:
 
  /// Access the associated cluster ID
  const eic::Index& clusterID() const;
 
  /// Access the number of valid parents
  const std::uint32_t& size() const;
 
  /// Access the (up to 4) parents for this cluster
  const std::array<eic::Index, 4>& parent() const;
  /// Access item i of the (up to 4) parents for this cluster
  const eic::Index& parent(size_t i) const;
 
 
  /// Set the associated cluster ID
  void clusterID(eic::Index value);
  /// Get reference to associated cluster ID
  eic::Index& clusterID();
 
  /// Set the number of valid parents
  void size(std::uint32_t value);
 
  /// Set the (up to 4) parents for this cluster
  void parent(std::array<eic::Index, 4> value);
  void parent(size_t i, eic::Index value);
  /// Get reference to (up to 4) parents for this cluster
  std::array<eic::Index, 4>& parent();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from MergedClusterRelationsObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const MergedClusterRelations& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstMergedClusterRelations& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MergedClusterRelations& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  MergedClusterRelationsObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstMergedClusterRelations& value);
 
} // namespace eic
 
 
#endif