Cluster3DInfo.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_Cluster3DInfo_H
#define EICD_Cluster3DInfo_H
 
#include "eicd/Cluster3DInfoConst.h"
#include "eicd/Cluster3DInfoObj.h"
 
#include "eicd/Direction.h"
#include "eicd/Index.h"
#include "eicd/VectorPolar.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class Cluster3DInfo
 *  Additional info for 3D clusters
 *  @author: S. Joosten
 */
class Cluster3DInfo {
 
  friend class Cluster3DInfoCollection;
  friend class Cluster3DInfoCollectionIterator;
  friend class ConstCluster3DInfo;
 
public:
 
  /// default constructor
  Cluster3DInfo();
  Cluster3DInfo(eic::Index clusterID, eic::VectorPolar polar, float eta, eic::Direction direction);
 
  /// constructor from existing Cluster3DInfoObj
  Cluster3DInfo(Cluster3DInfoObj* obj);
 
  /// copy constructor
  Cluster3DInfo(const Cluster3DInfo& other);
 
  /// copy-assignment operator
  Cluster3DInfo& operator=(const Cluster3DInfo& other);
 
  /// support cloning (deep-copy)
  Cluster3DInfo clone() const;
 
  /// destructor
  ~Cluster3DInfo();
 
  /// conversion to const object
  operator ConstCluster3DInfo() const;
 
public:
 
  /// Access the Primary cluster ID
  const eic::Index& clusterID() const;
 
  /// Access the Cluster position polar information
  const eic::VectorPolar& polar() const;
 
  /// Access the Cluster pseudorapidity
  const float& eta() const;
 
  /// Access the Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi]
  const eic::Direction& direction() const;
 
 
 
  /// Set the Primary cluster ID
  void clusterID(eic::Index value);
  /// Get reference to Primary cluster ID
  eic::Index& clusterID();
 
  /// Set the Cluster position polar information
  void polar(eic::VectorPolar value);
  /// Get reference to Cluster position polar information
  eic::VectorPolar& polar();
 
  /// Set the Cluster pseudorapidity
  void eta(float value);
 
  /// Set the Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi]
  void direction(eic::Direction value);
  /// Get reference to Intrinsic direction of the cluster at the central position [rad, 0->pi and -pi->pi]
  eic::Direction& direction();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from Cluster3DInfoObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const Cluster3DInfo& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstCluster3DInfo& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Cluster3DInfo& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  Cluster3DInfoObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstCluster3DInfo& value);
 
} // namespace eic
 
 
#endif