In This Package:

ILVolume.h

Go to the documentation of this file.

// $Id: ILVolume.h,v 1.12 2007/01/17 12:10:10 cattanem Exp $ 
// ===========================================================================
#ifndef  DETDESC_ILVOLUME_H
#define  DETDESC_ILVOLUME_H 1 
#include <iostream> 
#include <string> 
#include <vector> 
#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/Point3DTypes.h"
#include "GaudiKernel/Vector3DTypes.h"
#include "DetDesc/ISolid.h"

class StatusCode;
class Material; 
class IPVolume;
class ISolid;
template <class TYPE>
class SmartRefVector;
class Surface;

static const InterfaceID IID_ILVolume( 153 , 3 , 1 );

class ILVolume : virtual public IInterface
{
public:
  
  typedef  std::vector<IPVolume*>                        PVolumes;
  typedef  PVolumes::size_type                           ReplicaType;
  typedef  std::vector<ReplicaType>                      ReplicaPath;
  typedef  std::vector<const IPVolume*>                  PVolumePath;

  typedef std::pair<ISolid::Tick,ISolid::Tick>           Interval;  
  typedef std::pair<Interval,const Material*>            Intersection;
  typedef std::vector<Intersection>                      Intersections;
  
  typedef SmartRefVector<Surface>                         Surfaces;
  
public:
  
  static const InterfaceID& interfaceID() { return IID_ILVolume; }
  
public: 
  
  virtual const   std::string&  name          () const = 0;
  
  virtual bool                  isAssembly    () const = 0 ;
  
  virtual const ISolid*         solid         () const = 0;
  
  virtual const std::string&    materialName  () const = 0;
  
  virtual const Material*       material      () const = 0; 
  
  virtual       PVolumes&       pvolumes      ()       = 0 ;
  
  virtual const PVolumes&       pvolumes      () const = 0;
  
  virtual ILVolume::ReplicaType noPVolumes    () const = 0;
  
  virtual const IPVolume* operator[]
  ( const ILVolume::ReplicaType& index ) const = 0;
  
  virtual const IPVolume* operator[]
  ( const std::string&           name  ) const = 0;
  
  virtual const IPVolume* pvolume   
  ( const ILVolume::ReplicaType& index ) const = 0;
  
  virtual const IPVolume* pvolume   
  ( const std::string&           name  ) const = 0;
  
  virtual ILVolume::PVolumes::iterator       pvBegin     ()        = 0 ; 
  
  virtual ILVolume::PVolumes::const_iterator pvBegin     () const  = 0 ; 

  virtual ILVolume::PVolumes::iterator       pvEnd       ()        = 0 ; 
  
  virtual ILVolume::PVolumes::const_iterator pvEnd       () const  = 0 ; 

  virtual StatusCode traverse 
  ( ILVolume::ReplicaPath::const_iterator pathBegin,
    ILVolume::ReplicaPath::const_iterator pathEnd  ,
    ILVolume::PVolumePath&                volumePath ) const = 0;
  
  virtual StatusCode traverse 
  ( const ILVolume::ReplicaPath&  replicaPath,
    ILVolume::PVolumePath&        volumePath ) const = 0; 
  
  virtual bool isInside ( const Gaudi::XYZPoint& LocalPoint ) const = 0; 
  
  virtual StatusCode 
belongsTo
  ( const Gaudi::XYZPoint&        localPoint ,
    const int                level      , 
    ILVolume::PVolumePath&   volumePath ) const = 0;
  
  virtual StatusCode belongsTo
  ( const Gaudi::XYZPoint&        localPoint ,
    const int                level      , 
    ILVolume::ReplicaPath&   replicaPath ) const = 0;      
  
  virtual unsigned int intersectLine
  ( const Gaudi::XYZPoint        & Point         ,  
    const Gaudi::XYZVector       & Vector        ,  
    ILVolume::Intersections & intersections ,
    const double              threshold     ) const = 0 ; 
  
  virtual unsigned int intersectLine
  ( const Gaudi::XYZPoint        & Point         ,
    const Gaudi::XYZVector       & Vector        ,
    ILVolume::Intersections & intersections , 
    const ISolid::Tick        tickMin       ,
    const ISolid::Tick        tickMax       , 
    const double              Threshold     ) const = 0 ;
  
  virtual const std::string& sdName   ()                const = 0 ; 
  
  virtual const std::string& mfName   ()                const = 0 ;
  
  virtual       Surfaces& surfaces()        = 0 ; 
  
  virtual const Surfaces& surfaces() const  = 0 ;
  
  virtual std::ostream& printOut( std::ostream & os = std::cout) const = 0;
  
  virtual MsgStream&    printOut( MsgStream    & os ) const = 0;
  
  virtual ILVolume*  reset() = 0; 
  
protected: 

  virtual ~ILVolume() ;
};

// ============================================================================
// ============================================================================
inline std::ostream& operator<<( std::ostream& os , const ILVolume& lv ) 
{ return lv.printOut( os ); };

// ============================================================================
// ============================================================================
inline std::ostream& operator<<( std::ostream& os , const ILVolume*  lv )
{ return ((0==lv)?( os<<" ILVolume* points to NULL "):(os<<(*lv)));};

// ============================================================================
// ============================================================================
inline MsgStream& operator<<( MsgStream& os , const ILVolume& lv ) 
{ return lv.printOut( os ); };

// ============================================================================
// ============================================================================
inline MsgStream& operator<<( MsgStream& os , const ILVolume*  lv )
{ return ((0==lv)?( os<<" ILVolume* points to NULL "):(os<<(*lv)));};

// ============================================================================
// The End 
// ============================================================================
#endif  
// ============================================================================

---