ProtoCluster.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_ProtoCluster_H
#define EICD_ProtoCluster_H
 
#include "eicd/ProtoClusterConst.h"
#include "eicd/ProtoClusterObj.h"
 
#include "eicd/Index.h"
#include "eicd/Weight.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class ProtoCluster
 *  Relational info linking hits to their associated cluster
 *  @author: S. Joosten
 */
class ProtoCluster {
 
  friend class ProtoClusterCollection;
  friend class ProtoClusterCollectionIterator;
  friend class ConstProtoCluster;
 
public:
 
  /// default constructor
  ProtoCluster();
  ProtoCluster(eic::Index hitID, eic::Index clusterID, eic::Weight weight);
 
  /// constructor from existing ProtoClusterObj
  ProtoCluster(ProtoClusterObj* obj);
 
  /// copy constructor
  ProtoCluster(const ProtoCluster& other);
 
  /// copy-assignment operator
  ProtoCluster& operator=(const ProtoCluster& other);
 
  /// support cloning (deep-copy)
  ProtoCluster clone() const;
 
  /// destructor
  ~ProtoCluster();
 
  /// conversion to const object
  operator ConstProtoCluster() const;
 
public:
 
  /// Access the Hit ID
  const eic::Index& hitID() const;
 
  /// Access the ID of the cluster associated with this hit (-1 if none)
  const eic::Index& clusterID() const;
 
  /// Access the How much of this hit belongs to the cluster? [0->1]
  const eic::Weight& weight() const;
 
 
 
  /// Set the Hit ID
  void hitID(eic::Index value);
  /// Get reference to Hit ID
  eic::Index& hitID();
 
  /// Set the ID of the cluster associated with this hit (-1 if none)
  void clusterID(eic::Index value);
  /// Get reference to ID of the cluster associated with this hit (-1 if none)
  eic::Index& clusterID();
 
  /// Set the How much of this hit belongs to the cluster? [0->1]
  void weight(eic::Weight value);
  /// Get reference to How much of this hit belongs to the cluster? [0->1]
  eic::Weight& weight();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from ProtoClusterObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const ProtoCluster& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstProtoCluster& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const ProtoCluster& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  ProtoClusterObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstProtoCluster& value);
 
} // namespace eic
 
 
#endif