include/Geant4/G4ErrorSurfaceTarget.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4ErrorSurfaceTarget
0027 //
0028 // Class Description:
0029 //
0030 // Base class for G4ErrorTarget classes that are surfaces.
0031
0032 // Author: Pedro Arce (CIEMAT), September 2004
0033 // --------------------------------------------------------------------
0034 #ifndef G4ERRORSURFACETARGET_HH
0035 #define G4ERRORSURFACETARGET_HH
0036
0037 #include "globals.hh"
0038 #include "G4ThreeVector.hh"
0039 #include "G4ErrorTanPlaneTarget.hh"
0040 #include "G4Plane3D.hh"
0041
0042 /**
0043  * @brief G4ErrorSurfaceTarget is a base class for G4ErrorTarget classes
0044  * that are surfaces.
0045  */
0046
0047 class G4ErrorSurfaceTarget : public G4ErrorTanPlaneTarget
0048 {
0049   public:
0050
0051     /**
0052      * Default Constructor and Destructor.
0053      */
0054     G4ErrorSurfaceTarget() = default;
0055     ~G4ErrorSurfaceTarget() override = default;
0056
0057     /**
0058      * Computes the distance from a point to the surface in a given direction.
0059      *  @param[in] point The point of reference.
0060      *  @param[in] direc The direction vector.
0061      *  @returns The distance value.
0062      */
0063     G4double GetDistanceFromPoint( const G4ThreeVector& point,
0064                                    const G4ThreeVector& direc ) const override = 0;
0065
0066     /**
0067      * Computes the minimal distance from a point to the surface in any
0068      * direction.
0069      *  @param[in] point The point of reference.
0070      *  @returns The distance value.
0071      */
0072     G4double GetDistanceFromPoint( const G4ThreeVector& point ) const override = 0;
0073
0074     /**
0075      * Computes the plane tangent to surface at a given point.
0076      *  @param[in] point The point of reference.
0077      *  @returns The tangent plane.
0078      */
0079     G4Plane3D GetTangentPlane( const G4ThreeVector& point ) const override = 0;
0080
0081     /**
0082      * Dumps to standard output the surface parameters.
0083      */
0084     void Dump( const G4String& msg ) const override = 0;
0085 };
0086
0087 #endif