SHiP Field Service
Framework-agnostic C++20 library exposing SHiP magnetic field maps.
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
SHiP::CovfieFieldSource Class Referencefinal

Concrete IFieldSource aggregating one covfie-backed evaluator per magnet. More...

#include <CovfieFieldSource.h>

Inheritance diagram for SHiP::CovfieFieldSource:
[legend]
Collaboration diagram for SHiP::CovfieFieldSource:
[legend]

Classes

struct  MagnetConfig
 

Public Member Functions

 CovfieFieldSource (std::vector< MagnetConfig > magnets)
 
 ~CovfieFieldSource () override=default
 
 CovfieFieldSource (CovfieFieldSource const &)=delete
 
CovfieFieldSource & operator= (CovfieFieldSource const &)=delete
 
 CovfieFieldSource (CovfieFieldSource &&)=default
 
CovfieFieldSource & operator= (CovfieFieldSource &&)=default
 
std::vector< FieldRegion > const & regions () const override
 Idempotent. Ownership of the evaluators stays with the source.
 
- Public Member Functions inherited from SHiP::IFieldSource
virtual ~IFieldSource ()=default
 

Detailed Description

Concrete IFieldSource aggregating one covfie-backed evaluator per magnet.

Deprecated:
Reads .cvf files; see loadCovfieField.

Constructor & Destructor Documentation

◆ CovfieFieldSource() [1/3]

SHiP::CovfieFieldSource::CovfieFieldSource ( std::vector< MagnetConfig >  magnets)
explicit

◆ ~CovfieFieldSource()

SHiP::CovfieFieldSource::~CovfieFieldSource ( )
overridedefault

◆ CovfieFieldSource() [2/3]

SHiP::CovfieFieldSource::CovfieFieldSource ( CovfieFieldSource const &  )
delete

◆ CovfieFieldSource() [3/3]

SHiP::CovfieFieldSource::CovfieFieldSource ( CovfieFieldSource &&  )
default

Member Function Documentation

◆ operator=() [1/2]

CovfieFieldSource & SHiP::CovfieFieldSource::operator= ( CovfieFieldSource &&  )
default

◆ operator=() [2/2]

CovfieFieldSource & SHiP::CovfieFieldSource::operator= ( CovfieFieldSource const &  )
delete

◆ regions()

std::vector< FieldRegion > const & SHiP::CovfieFieldSource::regions ( ) const
inlineoverridevirtual

Idempotent. Ownership of the evaluators stays with the source.

Implements SHiP::IFieldSource.

The documentation for this class was generated from the following files: