include/G4HepEm/G4HepEmStateInit.hh

0001 #ifndef G4HepEmStateInit_HH
0002 #define G4HepEmStateInit_HH
0003
0004 struct G4HepEmState;
0005
0006 /**
0007  * @file    G4HepEmStateInit.hh
0008  * @author  B. Morgan
0009  * @date    2021
0010  *
0011  * @brief Function to initialize ``G4HepEmState`` data structure and members
0012  */
0013
0014 /**
0015  * Initialize a G4HepEmState struct with parameters and data from Geant4
0016  *
0017  * The input struct's pointers will be set to the newly initialized `G4HepEmParameters`
0018  * and `G4HepEmData` instances. These will be constructed using the underlying
0019  * parameters and data from Geant4.
0020  *
0021  * Any existing data held by the input struct will not be freed
0022  *
0023  * @param[in,out] hepEmState pointer to G4HepEmState struct to initialize
0024  *
0025  * @pre Underlying Geant4 data required by G4HepEm must be initialized
0026  *
0027  */
0028 void InitG4HepEmState(struct G4HepEmState* hepEmState);
0029
0030 #endif // G4HepEmStateInit_HH