GMagneto Class Reference
Represents a world containing collections of GFields and G4FieldManagers. More...
#include <gmagneto.h>
Inheritance diagram for GMagneto:
Collaboration diagram for GMagneto:
Public Member Functions | |
| GMagneto (GOptions *gopts) | |
| Constructs a GMagneto object and loads field definitions from options. More... | |
| ~GMagneto () | |
| Destructor to clean up dynamically allocated memory. More... | |
| bool | isField (std::string name) |
| Checks if a field with the given name exists. More... | |
| GField * | getField (std::string name) |
| Retrieves a GField object by its name. More... | |
| G4FieldManager * | getFieldMgr (std::string name) |
| Retrieves a G4FieldManager object by its name. More... | |
Detailed Description
GMagneto manages the lifecycle and access to magnetic field objects (GField) and their corresponding field managers (G4FieldManager).
Definition at line 15 of file gmagneto.h.
Constructor & Destructor Documentation
◆ GMagneto()
| GMagneto::GMagneto | ( | GOptions * | gopts | ) |
- Parameters
-
gopts Pointer to the GOptions object containing configuration options.
Definition at line 9 of file gmagneto.cc.
◆ ~GMagneto()
|
inline |
Definition at line 26 of file gmagneto.h.
Member Function Documentation
◆ getField()
|
inline |
- Parameters
-
name Name of the field to retrieve.
- Returns
- Pointer to the GField object.
- Exceptions
-
Logs an error and exits if the field is not found.
Definition at line 54 of file gmagneto.h.
◆ getFieldMgr()
|
inline |
- Parameters
-
name Name of the field manager to retrieve.
- Returns
- Pointer to the G4FieldManager object.
- Exceptions
-
Logs an error and exits if the field manager is not found.
Definition at line 69 of file gmagneto.h.
◆ isField()
|
inline |
- Parameters
-
name Name of the field to check.
- Returns
- True if the field exists, false otherwise.
Definition at line 43 of file gmagneto.h.
The documentation for this class was generated from the following files:
