GeoNodeAction.h

/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/

#ifndef GEOMODELKERNEL_GEONODEACTION_H
#define GEOMODELKERNEL_GEONODEACTION_H

#include "GeoModelKernel/GeoGraphNode.h"
#include "GeoModelKernel/GeoPhysVol.h"
#include "GeoModelKernel/GeoFullPhysVol.h"
#include "GeoModelKernel/GeoTransform.h"
#include "GeoModelKernel/GeoNameTag.h"
#include "GeoModelKernel/GeoIdentifierTag.h"
#include "GeoModelKernel/GeoSerialDenominator.h"
#include "GeoModelKernel/GeoSerialIdentifier.h"
#include "GeoModelKernel/GeoSerialTransformer.h"
#include "GeoModelKernel/GeoNodePath.h"

class GeoNodeAction 
{
 public:

  enum Depth
  { ALL_ANCESTORS = -1, SELF = 0, SELF_AND_CHILDREN = 1 };

 public:
  GeoNodeAction();
  virtual ~GeoNodeAction();
  
  //    Handles a Node.
  virtual void handleNode (const GeoGraphNode *);
  
  //    Handles a Transform.
  virtual void handleTransform (const GeoTransform *);
  
  //    Handles a physical volume.
  virtual void handlePhysVol (const GeoPhysVol *);
  
  //    Handles a physical volume.
  virtual void handleFullPhysVol (const GeoFullPhysVol *);
  
  //    Returns a pointer to the path object.
  GeoNodePath* getPath ();
  
  Query<unsigned int>  getDepthLimit ();
  
  //    Cause the action to terminate.
  void terminate ();
  
  //    Determine whether the action should terminate.
  bool shouldTerminate () const;
  
  //    Handles a Name Tag.
  virtual void handleNameTag (const GeoNameTag *);
  
  //    Handles a Serial Denominator.
  virtual void handleSerialDenominator (const GeoSerialDenominator *);
  
  //    Sets a depth limit.
  void setDepthLimit (unsigned int limit);
  
  //    Clears a depth limit, if any.
  void clearDepthLimit ();
  
  //    Handles a Serial Transformer
  virtual void handleSerialTransformer (const GeoSerialTransformer  *);
  
  //    Handles an Identifier Tag.
  virtual void handleIdentifierTag (const GeoIdentifierTag *);
  
  virtual void handleSerialIdentifier(const GeoSerialIdentifier *);

 protected:
  //    Termination flag; causes an abortion of action execution.
  bool m_terminate;

 private:
  GeoNodeAction(const GeoNodeAction &right);
  GeoNodeAction & operator=(const GeoNodeAction &right);
  
  //    A limit may be placed upon the depth to which the action
  //    descends.  0 = self.  1 = self and children.
  Query<unsigned int> m_depth;

  GeoNodePath m_path;  
};

#endif