MergedClusterRelationsConst.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_ConstMergedClusterRelations_H
#define EICD_ConstMergedClusterRelations_H
 
#include "eicd/MergedClusterRelationsObj.h"
 
#include "eicd/Index.h"
#include <array>
#include "podio/ObjectID.h"
 
 
 
namespace eic {
 
 
/** @class ConstMergedClusterRelations
 *  Relational info between a merged cluster and its parents
 *  @author: S. Joosten
 */
class ConstMergedClusterRelations {
 
  friend class MergedClusterRelations;
  friend class MergedClusterRelationsCollection;
  friend class MergedClusterRelationsConstCollectionIterator;
 
public:
  /// default constructor
  ConstMergedClusterRelations();
  ConstMergedClusterRelations(eic::Index clusterID, std::uint32_t size, std::array<eic::Index, 4> parent);
 
  /// constructor from existing MergedClusterRelationsObj
  ConstMergedClusterRelations(MergedClusterRelationsObj* obj);
 
  /// copy constructor
  ConstMergedClusterRelations(const ConstMergedClusterRelations& other);
 
  /// copy-assignment operator
  ConstMergedClusterRelations& operator=(const ConstMergedClusterRelations& other);
 
  /// support cloning (deep-copy)
  ConstMergedClusterRelations clone() const;
 
  /// destructor
  ~ConstMergedClusterRelations();
 
 
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;
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from MergedClusterRelationsObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const ConstMergedClusterRelations& other) const { return m_obj == other.m_obj; }
  bool operator==(const MergedClusterRelations& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const ConstMergedClusterRelations& 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;
};
 
} // namespace eic
 
 
#endif