IAP GITLAB

Skip to content
Snippets Groups Projects
Commit e5b39c3c authored by ralfulrich's avatar ralfulrich
Browse files

format...

parent b41ff346
No related branches found
No related tags found
1 merge request!6848 particle creator
Pipeline #258 passed
......@@ -8,4 +8,3 @@
* Licence version 3 (GPL Version 3). See file LICENSE for a full version of
* the license.
*/
......@@ -24,7 +24,7 @@ namespace corsika::stack {
class Stack; // forward decl
/**
@class StackIteratorInterface
@class StackIteratorInterface
The StackIteratorInterface is the main interface to iterator over
particles on a stack. At the same time StackIteratorInterface is a
......@@ -71,19 +71,20 @@ namespace corsika::stack {
StackIteratorInterface() = delete;
public:
/** iterator must always point to data, with an index:
@param data reference to the stack [rw]
@param index index on stack
/** iterator must always point to data, with an index:
@param data reference to the stack [rw]
@param index index on stack
*/
StackIteratorInterface(StackType& data, const int index)
: fIndex(index)
, fData(&data) {}
/** constructor that also sets new values on particle data object
@param data reference to the stack [rw]
@param index index on stack
@param args variadic list of data to initialize stack entry, this must be consistent
with the definition of the user-provided ParticleInterfaceType::SetParticleData(...) function
@param data reference to the stack [rw]
@param index index on stack
@param args variadic list of data to initialize stack entry, this must be
consistent with the definition of the user-provided
ParticleInterfaceType::SetParticleData(...) function
*/
template <typename... Args>
StackIteratorInterface(StackType& data, const int index, const Args... args)
......@@ -93,12 +94,14 @@ namespace corsika::stack {
}
/** constructor that also sets new values on particle data object, including reference
to parent particle
@param data reference to the stack [rw]
@param index index on stack
@param reference to parent particle [rw]. This can be used for thinning, particle counting, history, etc.
@param args variadic list of data to initialize stack entry, this must be consistent
with the definition of the user-provided ParticleInterfaceType::SetParticleData(...) function
to parent particle
@param data reference to the stack [rw]
@param index index on stack
@param reference to parent particle [rw]. This can be used for thinning, particle
counting, history, etc.
@param args variadic list of data to initialize stack entry, this must be
consistent with the definition of the user-provided
ParticleInterfaceType::SetParticleData(...) function
*/
template <typename... Args>
StackIteratorInterface(StackType& data, const int index,
......@@ -181,19 +184,19 @@ namespace corsika::stack {
: fIndex(index)
, fData(&data) {}
/**
@class ConstStackIteratorInterface
/**
@class ConstStackIteratorInterface
The const counterpart of StackIteratorInterface, which is used
for read-only iterator access on particle stack:
The const counterpart of StackIteratorInterface, which is used
for read-only iterator access on particle stack:
\verbatim
for (const auto& p : theStack) { E += p.GetEnergy(); }
\endverbatim
\verbatim
for (const auto& p : theStack) { E += p.GetEnergy(); }
\endverbatim
See documentation of StackIteratorInterface for more details.
*/
See documentation of StackIteratorInterface for more details.
*/
public:
/** @name Iterator interface
*/
......@@ -218,17 +221,15 @@ namespace corsika::stack {
return static_cast<const ParticleInterfaceType&>(*this);
}
///@}
protected:
/** @name Stack data access
Only the const versions for read-only access
Only the const versions for read-only access
*/
///@{
inline int GetIndex() const { return fIndex; }
inline const StackType& GetStack() const { return *fData; }
inline const StackData& GetStackData() const {
return fData->GetStackData();
}
inline const StackData& GetStackData() const { return fData->GetStackData(); }
///@}
}; // end class ConstStackIterator
......
......@@ -8,4 +8,3 @@
* Licence version 3 (GPL Version 3). See file LICENSE for a full version of
* the license.
*/
......@@ -8,4 +8,3 @@
* Licence version 3 (GPL Version 3). See file LICENSE for a full version of
* the license.
*/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment