Skip to content

Commit

Permalink
follow name convention
Browse files Browse the repository at this point in the history
  • Loading branch information
martinunland committed Sep 2, 2024
1 parent a09f379 commit 1e89506
Show file tree
Hide file tree
Showing 16 changed files with 71 additions and 71 deletions.
2 changes: 1 addition & 1 deletion common/geometry_construction/include/OMSimDEGG.hh
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class DEggHarness;
*
* The DEGG class is responsible for constructing the D-Egg detector geometry. It creates the pressure
* vessel, the inner volume, and places the PMTs inside the logical volume of the gel. The class is derived
* from the `abcDetectorComponent` base class.
* from the `OMSimDetectorComponent` base class.
* @ingroup common
*/
class DEGG : public OMSimOpticalModule
Expand Down
4 changes: 2 additions & 2 deletions common/geometry_construction/include/OMSimDEGGHarness.hh
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
*/

#pragma once
#include "abcDetectorComponent.hh"
#include "OMSimDetectorComponent.hh"

class DEGG;
class DEggHarness : public abcDetectorComponent
class DEggHarness : public OMSimDetectorComponent
{
public:
DEggHarness(DEGG *pDEGG);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

/**
* @file abcDetectorComponent.hh
* @brief Provides helper base class abcDetectorComponent for constructing and managing detector components in OMSim.
* @file OMSimDetectorComponent.hh
* @brief Provides helper base class OMSimDetectorComponent for constructing and managing detector components in OMSim.
* @ingroup common
*/
#pragma once
Expand All @@ -14,28 +14,28 @@
#include <G4PVPlacement.hh>

/**
* @class abcDetectorComponent
* @class OMSimDetectorComponent
* @brief Abstract base class used for constructing detector components.
*
* @details This class serves as a base class for constructing and manipulating detector components in OMSim. It provides a set of helper functions for creating and arranging components within a detector, as well as methods for altering the geometry, such as subtracting one component from another. The class maintains an internal list of components, allowing for operations to be performed on all components simultaneously.
* The `placeIt` methods allow for the placement of components within a specified logical volume, either via individual positioning and rotation parameters, or via a Geant4 transformation. Furthermore, components from one `abcDetectorComponent` instance can be integrated into another, with user-specified position, rotation, and name extension. This makes it possible to build complex geometrical structures in a modular fashion in cases where a single mother volume cannot be used.
* The `placeIt` methods allow for the placement of components within a specified logical volume, either via individual positioning and rotation parameters, or via a Geant4 transformation. Furthermore, components from one `OMSimDetectorComponent` instance can be integrated into another, with user-specified position, rotation, and name extension. This makes it possible to build complex geometrical structures in a modular fashion in cases where a single mother volume cannot be used.
*
* @ingroup common
*/
class abcDetectorComponent
class OMSimDetectorComponent
{
public:
abcDetectorComponent();
virtual void construction() = 0; ///< Abstract method you have to define in order to make a derived class from abcDetectorComponent
OMSimDetectorComponent();
virtual void construction() = 0; ///< Abstract method you have to define in order to make a derived class from OMSimDetectorComponent

OMSimInputData *m_data; ///< Instance of OMSimInputdata, which should be started only once.
bool m_checkOverlaps = false;

/**
* @struct abcDetectorComponent::Component
* @brief This struct represents a single detector component within an abcDetectorComponent instance.
* @struct OMSimDetectorComponent::Component
* @brief This struct represents a single detector component within an OMSimDetectorComponent instance.
* @details A Component is defined by several properties which specify its physical properties and location within the detector.
* All operations available in abcDetectorComponent utilize this struct to perform changes to handle all components.
* All operations available in OMSimDetectorComponent utilize this struct to perform changes to handle all components.
*/
struct Component
{
Expand All @@ -58,7 +58,7 @@ public:
Component getComponent(G4String pName);
G4Transform3D getNewPosition(G4ThreeVector pPosition, G4RotationMatrix pRotation, G4ThreeVector pObjectPosition, G4RotationMatrix pObjectRotation);

void integrateDetectorComponent(abcDetectorComponent *pToIntegrate, G4ThreeVector pPosition, G4RotationMatrix pRotation, G4String pNameExtension);
void integrateDetectorComponent(OMSimDetectorComponent *pToIntegrate, G4ThreeVector pPosition, G4RotationMatrix pRotation, G4String pNameExtension);
void deleteComponent(G4String pName);

void placeIt(G4ThreeVector pPosition, G4RotationMatrix pRotation, G4LogicalVolume *&pMother, G4String pNameExtension = "");
Expand Down
4 changes: 2 additions & 2 deletions common/geometry_construction/include/OMSimMDOMFlasher.hh
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

#pragma once

#include "abcDetectorComponent.hh"
#include "OMSimDetectorComponent.hh"
#include <G4UnionSolid.hh>
#include <G4Navigator.hh>

Expand Down Expand Up @@ -41,7 +41,7 @@ struct GlobalPosition
* activating a specific flasher in a particular module, and configuring the GPS for flasher simulations.
* @ingroup common
*/
class mDOMFlasher : public abcDetectorComponent
class mDOMFlasher : public OMSimDetectorComponent
{
public:
mDOMFlasher();
Expand Down
4 changes: 2 additions & 2 deletions common/geometry_construction/include/OMSimMDOMHarness.hh
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
*/
#pragma once

#include "abcDetectorComponent.hh"
#include "OMSimDetectorComponent.hh"
#include <G4IntersectionSolid.hh>
#include <G4Cons.hh>

class mDOM;
class mDOMHarness : public abcDetectorComponent
class mDOMHarness : public OMSimDetectorComponent
{
public:
mDOMHarness(mDOM* pMDOM);
Expand Down
4 changes: 2 additions & 2 deletions common/geometry_construction/include/OMSimOpticalModule.hh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* @ingroup common
*/
#pragma once
#include "abcDetectorComponent.hh"
#include "OMSimDetectorComponent.hh"
#include "OMSimHitManager.hh"
#include "OMSimPMTConstruction.hh"
class OMSimDetectorConstruction;
Expand All @@ -19,7 +19,7 @@ class OMSimDetectorConstruction;
* @brief Base class for OMs works as interface
* @ingroup common
*/
class OMSimOpticalModule : public abcDetectorComponent
class OMSimOpticalModule : public OMSimDetectorComponent
{
public:
OMSimOpticalModule(OMSimPMTConstruction* pPMTManager);
Expand Down
4 changes: 2 additions & 2 deletions common/geometry_construction/include/OMSimPMTConstruction.hh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
*/

#pragma once
#include "abcDetectorComponent.hh"
#include "OMSimDetectorComponent.hh"
#include "OMSimPMTConstruction.hh"
#include "OMSimPMTResponse.hh"
//#include "OMSimDetectorConstruction.hh"
Expand All @@ -15,7 +15,7 @@
class OMSimDetectorConstruction;


class OMSimPMTConstruction : public abcDetectorComponent
class OMSimPMTConstruction : public OMSimDetectorComponent
{

public:
Expand Down
2 changes: 1 addition & 1 deletion common/geometry_construction/src/OMSimDEGGHarness.cc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#include <G4Tubs.hh>


DEggHarness::DEggHarness(DEGG *pDEGG): abcDetectorComponent(), m_opticalModule(pDEGG)
DEggHarness::DEggHarness(DEGG *pDEGG): OMSimDetectorComponent(), m_opticalModule(pDEGG)
{
construction();
}
Expand Down
Loading

0 comments on commit 1e89506

Please sign in to comment.