CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
edm::AsciiOutputModule Class Reference
Inheritance diagram for edm::AsciiOutputModule:
edm::global::OutputModule<> edm::global::OutputModuleBase edm::EDConsumerBase

Public Member Functions

 AsciiOutputModule (ParameterSet const &pset)
 
virtual ~AsciiOutputModule ()
 
- Public Member Functions inherited from edm::global::OutputModule<>
 OutputModule (edm::ParameterSet const &iPSet)
 
- Public Member Functions inherited from edm::global::OutputModuleBase
BranchIDLists const * branchIDLists ()
 
std::array< bool,
NumBranchTypes > const & 
hasNewlyDroppedBranch () const
 
SelectedProductsForBranchType
const & 
keptProducts () const
 
int maxEvents () const
 
const ModuleDescriptionmoduleDescription () const
 
OutputModuleBaseoperator= (OutputModuleBase const &)=delete
 
 OutputModuleBase (ParameterSet const &pset)
 
 OutputModuleBase (OutputModuleBase const &)=delete
 
std::string const & processName () const
 
int remainingEvents () const
 
bool selected (BranchDescription const &desc) const
 
void selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &)
 
ThinnedAssociationsHelper const * thinnedAssociationsHelper () const
 
bool wantAllEvents () const
 
virtual ~OutputModuleBase ()
 
- Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfoconsumesInfo () const
 
 EDConsumerBase ()
 
ProductHolderIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
std::vector
< ProductHolderIndexAndSkipBit >
const & 
itemsToGetFromEvent () const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
void modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
 
void modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
 
bool registeredToConsume (ProductHolderIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
void updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
 
virtual ~EDConsumerBase ()
 

Static Public Member Functions

static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
- Static Public Member Functions inherited from edm::global::OutputModuleBase
static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc)
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 

Private Member Functions

virtual void write (EventPrincipal const &e, ModuleCallingContext const *) override
 
virtual void writeLuminosityBlock (LuminosityBlockPrincipal const &, ModuleCallingContext const *) override
 
virtual void writeRun (RunPrincipal const &, ModuleCallingContext const *) override
 

Private Attributes

int counter_
 
int prescale_
 
int verbosity_
 

Additional Inherited Members

- Public Types inherited from edm::global::OutputModuleBase
typedef OutputModuleBase ModuleType
 
- Public Types inherited from edm::EDConsumerBase
typedef ProductLabels Labels
 
- Protected Member Functions inherited from edm::global::OutputModuleBase
void configure (OutputModuleDescription const &desc)
 
ModuleDescription const & description () const
 
void doBeginJob ()
 
bool doBeginLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *)
 
bool doBeginRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *)
 
void doBeginStream (StreamID id)
 
void doEndJob ()
 
bool doEndLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *)
 
bool doEndRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *)
 
void doEndStream (StreamID id)
 
bool doEvent (EventPrincipal const &ep, EventSetup const &c, ActivityRegistry *, ModuleCallingContext const *)
 
void doPreallocate (PreallocationConfiguration const &)
 
void doStreamBeginLuminosityBlock (StreamID id, LuminosityBlockPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
void doStreamBeginRun (StreamID id, RunPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
void doStreamEndLuminosityBlock (StreamID id, LuminosityBlockPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
void doStreamEndRun (StreamID id, RunPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
 
std::map< BranchID::value_type,
BranchID::value_type > const & 
droppedBranchIDToKeptBranchID ()
 
ParameterSetID selectorConfig () const
 
void setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int > > > const &outputModulePathPositions, bool anyProductProduced)
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken consumes (TypeToGet const &id, edm::InputTag const &tag)
 
ConsumesCollector consumesCollector ()
 Use a ConsumesCollector to gather consumes information from helper functions. More...
 
template<typename ProductType , BranchType B = InEvent>
void consumesMany ()
 
void consumesMany (const TypeToGet &id)
 
template<BranchType B>
void consumesMany (const TypeToGet &id)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 

Detailed Description

Definition at line 22 of file AsciiOutputModule.cc.

Constructor & Destructor Documentation

edm::AsciiOutputModule::AsciiOutputModule ( ParameterSet const &  pset)
explicit

Definition at line 38 of file AsciiOutputModule.cc.

References prescale_.

38  :
39  global::OutputModuleBase(pset),
40  global::OutputModule<>(pset),
41  prescale_(pset.getUntrackedParameter<unsigned int>("prescale")),
42  verbosity_(pset.getUntrackedParameter<unsigned int>("verbosity")),
43  counter_(0) {
44  if (prescale_ == 0) prescale_ = 1;
45  }
edm::AsciiOutputModule::~AsciiOutputModule ( )
virtual

Definition at line 47 of file AsciiOutputModule.cc.

References counter_.

47  {
48  LogAbsolute("AsciiOut") << ">>> processed " << counter_ << " events" << std::endl;
49  }

Member Function Documentation

void edm::AsciiOutputModule::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 88 of file AsciiOutputModule.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), edm::OutputModule::fillDescription(), edm::ParameterSetDescription::setComment(), and edm::ParameterDescriptionNode::setComment().

88  {
90  desc.setComment("Outputs event information into text file.");
91  desc.addUntracked("prescale", 1U)
92  ->setComment("prescale factor");
93  desc.addUntracked("verbosity", 1U)
94  ->setComment("0: no output\n"
95  "1: event ID and timestamp only\n"
96  ">1: full output");
98  descriptions.add("asciiOutput", desc);
99  }
static void fillDescription(ParameterSetDescription &desc)
void edm::AsciiOutputModule::write ( EventPrincipal const &  e,
ModuleCallingContext const *   
)
overrideprivatevirtual

Implements edm::global::OutputModuleBase.

Definition at line 52 of file AsciiOutputModule.cc.

References edm::ProcessHistory::begin(), counter_, edm::ProcessHistory::end(), edm::Principal::getAllProvenance(), i, edm::EventPrincipal::id(), prescale_, edm::Principal::processHistory(), edm::global::OutputModuleBase::selected(), edm::EventPrincipal::time(), edm::Timestamp::value(), and verbosity_.

Referenced by pkg.AbstractPkg::generate().

52  {
53 
54  if ((++counter_ % prescale_) != 0 || verbosity_ <= 0) return;
55 
56  // Run const& run = evt.getRun(); // this is still unused
57  LogAbsolute("AsciiOut")<< ">>> processing event # " << e.id() << " time " << e.time().value() << std::endl;
58 
59  if (verbosity_ <= 1) return;
60 
61  // Write out non-EDProduct contents...
62 
63  // ... list of process-names
64  for (ProcessHistory::const_iterator it = e.processHistory().begin(), itEnd = e.processHistory().end();
65  it != itEnd; ++it) {
66  LogAbsolute("AsciiOut") << it->processName() << " ";
67  }
68 
69  // ... collision id
70  LogAbsolute("AsciiOut") << '\n' << e.id() << '\n';
71 
72  // Loop over products, and write some output for each...
73 
74  std::vector<Provenance const*> provs;
75  e.getAllProvenance(provs);
76  for(std::vector<Provenance const*>::const_iterator i = provs.begin(),
77  iEnd = provs.end();
78  i != iEnd;
79  ++i) {
80  BranchDescription const& desc = (*i)->product();
81  if (selected(desc)) {
82  LogAbsolute("AsciiOut") << **i << '\n';
83  }
84  }
85  }
collection_type::const_iterator const_iterator
int i
Definition: DBlmapReader.cc:9
bool selected(BranchDescription const &desc) const
virtual void edm::AsciiOutputModule::writeLuminosityBlock ( LuminosityBlockPrincipal const &  ,
ModuleCallingContext const *   
)
inlineoverrideprivatevirtual

Implements edm::global::OutputModuleBase.

Definition at line 31 of file AsciiOutputModule.cc.

31 {}
virtual void edm::AsciiOutputModule::writeRun ( RunPrincipal const &  ,
ModuleCallingContext const *   
)
inlineoverrideprivatevirtual

Implements edm::global::OutputModuleBase.

Definition at line 32 of file AsciiOutputModule.cc.

32 {}

Member Data Documentation

int edm::AsciiOutputModule::counter_
private

Definition at line 35 of file AsciiOutputModule.cc.

Referenced by write(), and ~AsciiOutputModule().

int edm::AsciiOutputModule::prescale_
private

Definition at line 33 of file AsciiOutputModule.cc.

Referenced by AsciiOutputModule(), and write().

int edm::AsciiOutputModule::verbosity_
private

Definition at line 34 of file AsciiOutputModule.cc.

Referenced by write().