CORSIKA  @c8_version@
The framework to simulate particle cascades for astroparticle physics
Public Member Functions | List of all members
corsika::AntennaCollection< TAntennaImpl > Class Template Reference

The base interface for radio detectors. More...

#include <AntennaCollection.hpp>

Public Member Functions

void addAntenna (TAntennaImpl const &antenna)
 Add an antenna to this radio process. More...
 
TAntennaImpl & at (std::size_t const i)
 Get the specific antenna at that place in the collection. More...
 
TAntennaImpl const & at (std::size_t const i) const
 
int size () const
 Get the number of antennas in the collection.
 
std::vector< TAntennaImpl > & getAntennas ()
 Get a non-const reference to the collection of antennas. More...
 
std::vector< TAntennaImpl > const & getAntennas () const
 Get a const reference to the collection of antennas. More...
 
void reset ()
 Reset all the antenna waveforms.
 

Detailed Description

template<typename TAntennaImpl>
class corsika::AntennaCollection< TAntennaImpl >

The base interface for radio detectors.

At the moment it is a collection of antennas with the same implementation.

Definition at line 18 of file AntennaCollection.hpp.

Member Function Documentation

◆ addAntenna()

template<typename TAntennaImpl >
void corsika::AntennaCollection< TAntennaImpl >::addAntenna ( TAntennaImpl const &  antenna)

Add an antenna to this radio process.

Parameters
antennaThe antenna to add

◆ at()

template<typename TAntennaImpl >
TAntennaImpl& corsika::AntennaCollection< TAntennaImpl >::at ( std::size_t const  i)

Get the specific antenna at that place in the collection.

Parameters
indexin the collection

◆ getAntennas() [1/2]

template<typename TAntennaImpl >
std::vector<TAntennaImpl>& corsika::AntennaCollection< TAntennaImpl >::getAntennas ( )

Get a non-const reference to the collection of antennas.

Returns
An iterable mutable reference to the antennas.

◆ getAntennas() [2/2]

template<typename TAntennaImpl >
std::vector<TAntennaImpl> const& corsika::AntennaCollection< TAntennaImpl >::getAntennas ( ) const

Get a const reference to the collection of antennas.

Returns
An iterable mutable reference to the antennas.
The documentation for this class was generated from the following file: