CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes
magneticfield::VolumeBasedMagneticFieldESProducer Class Reference
Inheritance diagram for magneticfield::VolumeBasedMagneticFieldESProducer:
edm::ESProducer edm::ESProxyFactoryProducer edm::eventsetup::DataProxyProvider

Public Member Functions

const VolumeBasedMagneticFieldESProduceroperator= (const VolumeBasedMagneticFieldESProducer &)=delete
 
std::unique_ptr< MagneticFieldproduce (const IdealMagneticFieldRecord &iRecord)
 
 VolumeBasedMagneticFieldESProducer (const edm::ParameterSet &iConfig)
 
 VolumeBasedMagneticFieldESProducer (const VolumeBasedMagneticFieldESProducer &)=delete
 
- Public Member Functions inherited from edm::ESProducer
 ESProducer ()
 
 ESProducer (const ESProducer &)=delete
 
ESProxyIndex const * getTokenIndices (unsigned int iIndex) const
 
ESRecordIndex const * getTokenRecordIndices (unsigned int iIndex) const
 
bool hasMayConsumes () const noexcept
 
size_t numberOfTokenIndices (unsigned int iIndex) const
 
ESProducer const & operator= (const ESProducer &)=delete
 
SerialTaskQueueChainqueue ()
 
template<typename Record >
std::optional< std::vector< ESProxyIndex > > updateFromMayConsumes (unsigned int iIndex, const Record &iRecord) const
 
void updateLookup (eventsetup::ESRecordsToProxyIndices const &) final
 
 ~ESProducer () noexcept(false) override
 
- Public Member Functions inherited from edm::ESProxyFactoryProducer
 ESProxyFactoryProducer ()
 
 ESProxyFactoryProducer (const ESProxyFactoryProducer &)=delete
 
const ESProxyFactoryProduceroperator= (const ESProxyFactoryProducer &)=delete
 
 ~ESProxyFactoryProducer () noexcept(false) override
 
- Public Member Functions inherited from edm::eventsetup::DataProxyProvider
void createKeyedProxies (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
 
 DataProxyProvider ()
 
 DataProxyProvider (const DataProxyProvider &)=delete
 
const ComponentDescriptiondescription () const
 
void fillRecordsNotAllowingConcurrentIOVs (std::set< EventSetupRecordKey > &recordsNotAllowingConcurrentIOVs) const
 
virtual void initConcurrentIOVs (EventSetupRecordKey const &key, unsigned int nConcurrentIOVs)
 
bool isUsingRecord (const EventSetupRecordKey &key) const
 
KeyedProxieskeyedProxies (const EventSetupRecordKey &iRecordKey, unsigned int iovIndex=0)
 
const DataProxyProvideroperator= (const DataProxyProvider &)=delete
 
void setAppendToDataLabel (const edm::ParameterSet &)
 
void setDescription (const ComponentDescription &iDescription)
 
std::set< EventSetupRecordKeyusingRecords () const
 
virtual ~DataProxyProvider () noexcept(false)
 

Private Attributes

const MagFieldConfig conf_
 
edm::ESGetToken< DDCompactView, IdealMagneticFieldRecordcpvToken_
 
const bool debug_
 
edm::ESGetToken< MagneticField, IdealMagneticFieldRecordparamFieldToken_
 
const bool useParametrizedTrackerField_
 
const std::string version_
 

Additional Inherited Members

- Static Public Member Functions inherited from edm::eventsetup::DataProxyProvider
static void prevalidate (ConfigurationDescriptions &)
 
- Protected Types inherited from edm::ESProxyFactoryProducer
using EventSetupRecordKey = eventsetup::EventSetupRecordKey
 
- Protected Types inherited from edm::eventsetup::DataProxyProvider
using KeyedProxiesVector = std::vector< std::pair< DataKey, std::shared_ptr< DataProxy > >>
 
- Protected Member Functions inherited from edm::ESProducer
template<typename T >
auto setWhatProduced (T *iThis, const es::Label &iLabel={})
 
template<typename T >
auto setWhatProduced (T *iThis, const char *iLabel)
 
template<typename T >
auto setWhatProduced (T *iThis, const std::string &iLabel)
 
template<typename T , typename TDecorator >
auto setWhatProduced (T *iThis, const TDecorator &iDec, const es::Label &iLabel={})
 
template<typename T , typename TReturn , typename TRecord >
auto setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const es::Label &iLabel={})
 
template<typename T , typename TReturn , typename TRecord , typename TArg >
ESConsumesCollectorT< TRecord > setWhatProduced (T *iThis, TReturn(T ::*iMethod)(const TRecord &), const TArg &iDec, const es::Label &iLabel={})
 
void usesResources (std::vector< std::string > const &)
 
- Protected Member Functions inherited from edm::ESProxyFactoryProducer
template<class TFactory >
void registerFactory (std::unique_ptr< TFactory > iFactory, const std::string &iLabel=std::string())
 
virtual void registerFactoryWithKey (const EventSetupRecordKey &iRecord, std::unique_ptr< eventsetup::ProxyFactoryBase > iFactory, const std::string &iLabel=std::string())
 
KeyedProxiesVector registerProxies (const EventSetupRecordKey &, unsigned int iovIndex) override
 
- Protected Member Functions inherited from edm::eventsetup::DataProxyProvider
template<class T >
void usingRecord ()
 
void usingRecordWithKey (const EventSetupRecordKey &key)
 

Detailed Description

Definition at line 26 of file VolumeBasedMagneticFieldESProducer.cc.

Constructor & Destructor Documentation

◆ VolumeBasedMagneticFieldESProducer() [1/2]

VolumeBasedMagneticFieldESProducer::VolumeBasedMagneticFieldESProducer ( const edm::ParameterSet iConfig)

Definition at line 49 of file VolumeBasedMagneticFieldESProducer.cc.

References edm::ParameterSet::getUntrackedParameter().

50  : debug_{iConfig.getUntrackedParameter<bool>("debugBuilder", false)},
51  useParametrizedTrackerField_{iConfig.getParameter<bool>("useParametrizedTrackerField")},
52  conf_{iConfig, debug_},
53  version_{iConfig.getParameter<std::string>("version")} {
54  auto cc = setWhatProduced(this, iConfig.getUntrackedParameter<std::string>("label", ""));
55  cpvToken_ = cc.consumes(edm::ESInputTag{"", "magfield"});
57  paramFieldToken_ = cc.consumes(edm::ESInputTag{"", iConfig.getParameter<string>("paramLabel")});
58  }
59 }
auto setWhatProduced(T *iThis, const es::Label &iLabel={})
Definition: ESProducer.h:163
T getParameter(std::string const &) const
Definition: ParameterSet.h:303
edm::ESGetToken< DDCompactView, IdealMagneticFieldRecord > cpvToken_
T getUntrackedParameter(std::string const &, T const &) const
edm::ESGetToken< MagneticField, IdealMagneticFieldRecord > paramFieldToken_

◆ VolumeBasedMagneticFieldESProducer() [2/2]

magneticfield::VolumeBasedMagneticFieldESProducer::VolumeBasedMagneticFieldESProducer ( const VolumeBasedMagneticFieldESProducer )
delete

Member Function Documentation

◆ operator=()

const VolumeBasedMagneticFieldESProducer& magneticfield::VolumeBasedMagneticFieldESProducer::operator= ( const VolumeBasedMagneticFieldESProducer )
delete

◆ produce()

std::unique_ptr< MagneticField > VolumeBasedMagneticFieldESProducer::produce ( const IdealMagneticFieldRecord iRecord)

Definition at line 62 of file VolumeBasedMagneticFieldESProducer.cc.

References MagGeoBuilderFromDDD::barrelLayers(), MagGeoBuilderFromDDD::barrelVolumes(), MagGeoBuilderFromDDD::build(), conf_, cpvToken_, debug_, MagGeoBuilderFromDDD::endcapSectors(), MagGeoBuilderFromDDD::endcapVolumes(), MagFieldConfig::geometryVersion, edm::eventsetup::DependentRecordImplementation< RecordT, ListT >::get(), edm::eventsetup::DependentRecordImplementation< RecordT, ListT >::getTransientHandle(), MagFieldConfig::gridFiles, MagFieldConfig::keys, LogTrace, MagGeoBuilderFromDDD::maxR(), MagGeoBuilderFromDDD::maxZ(), paramFieldToken_, MagGeoBuilderFromDDD::setGridFiles(), MagGeoBuilderFromDDD::setScaling(), useParametrizedTrackerField_, MagFieldConfig::values, MagFieldConfig::version, and version_.

62  {
63  LogTrace("MagGeoBuilder") << "VolumeBasedMagneticFieldESProducer::produce() " << version_;
64 
65  auto cpv = iRecord.getTransientHandle(cpvToken_);
67 
68  // Set scaling factors
69  if (!conf_.keys.empty()) {
70  builder.setScaling(conf_.keys, conf_.values);
71  }
72 
73  // Set specification for the grid tables to be used.
74  if (!conf_.gridFiles.empty()) {
75  builder.setGridFiles(conf_.gridFiles);
76  }
77 
78  builder.build(*cpv);
79 
80  // Get slave field (from ES)
81  const MagneticField* paramField = nullptr;
83  paramField = &iRecord.get(paramFieldToken_);
84  }
85  return std::make_unique<VolumeBasedMagneticField>(conf_.geometryVersion,
86  builder.barrelLayers(),
87  builder.endcapSectors(),
88  builder.barrelVolumes(),
89  builder.endcapVolumes(),
90  builder.maxR(),
91  builder.maxZ(),
92  paramField,
93  false);
94 }
ESTransientHandle< ProductT > getTransientHandle(ESGetToken< ProductT, DepRecordT > const &iToken) const
std::vector< double > values
#define LogTrace(id)
edm::ESGetToken< DDCompactView, IdealMagneticFieldRecord > cpvToken_
magneticfield::TableFileMap gridFiles
Specification of which data table is to be used for each volume.
std::vector< int > keys
Scaling factors for the field in specific volumes.
std::string version
Version of the data tables to be used.
int geometryVersion
Version of the geometry to be used.
edm::ESGetToken< MagneticField, IdealMagneticFieldRecord > paramFieldToken_
ProductT const & get(ESGetToken< ProductT, DepRecordT > const &iToken) const

Member Data Documentation

◆ conf_

const MagFieldConfig magneticfield::VolumeBasedMagneticFieldESProducer::conf_
private

Definition at line 39 of file VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

◆ cpvToken_

edm::ESGetToken<DDCompactView, IdealMagneticFieldRecord> magneticfield::VolumeBasedMagneticFieldESProducer::cpvToken_
private

Definition at line 41 of file VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

◆ debug_

const bool magneticfield::VolumeBasedMagneticFieldESProducer::debug_
private

Definition at line 37 of file VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

◆ paramFieldToken_

edm::ESGetToken<MagneticField, IdealMagneticFieldRecord> magneticfield::VolumeBasedMagneticFieldESProducer::paramFieldToken_
private

Definition at line 42 of file VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

◆ useParametrizedTrackerField_

const bool magneticfield::VolumeBasedMagneticFieldESProducer::useParametrizedTrackerField_
private

Definition at line 38 of file VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().

◆ version_

const std::string magneticfield::VolumeBasedMagneticFieldESProducer::version_
private

Definition at line 40 of file VolumeBasedMagneticFieldESProducer.cc.

Referenced by produce().