CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
edm::DocFormatHelper Class Reference

#include <DocFormatHelper.h>

Public Types

enum  DescriptionParent {
  TOP, OR, XOR, AND,
  OTHER
}
 

Public Member Functions

bool brief () const
 
size_t column1 () const
 
size_t column2 () const
 
size_t column3 () const
 
size_t commentWidth () const
 
int counter () const
 
void decrementCounter ()
 
 DocFormatHelper ()
 
void incrementCounter ()
 
void indent (std::ostream &os) const
 
void indent2 (std::ostream &os) const
 
int indentation () const
 
void init ()
 
size_t lineWidth () const
 
DescriptionParent parent () const
 
int pass () const
 
std::string const & section () const
 
void setAtLeast1 (size_t width)
 
void setAtLeast2 (size_t width)
 
void setAtLeast3 (size_t width)
 
void setBrief (bool value)
 
void setCounter (int value)
 
void setIndentation (int value)
 
void setLineWidth (size_t value)
 
void setParent (DescriptionParent value)
 
void setPass (int value)
 
void setSection (std::string const &value)
 
int startColumn2 () const
 

Static Public Member Functions

static int offsetModuleLabel ()
 
static int offsetSectionContent ()
 
static int offsetTopLevelPSet ()
 
static void wrapAndPrintText (std::ostream &os, std::string const &text, size_t indent, size_t suggestedWidth)
 

Private Attributes

bool brief_
 
size_t column1_
 
size_t column2_
 
size_t column3_
 
int counter_
 
int indentation_
 
size_t lineWidth_
 
DescriptionParent parent_
 
int pass_
 
std::string section_
 
size_t startColumn2_
 

Detailed Description

Definition at line 15 of file DocFormatHelper.h.

Member Enumeration Documentation

enum edm::DocFormatHelper::DescriptionParent
Enumerator
TOP 
OR 
XOR 
AND 
OTHER 

Definition at line 19 of file DocFormatHelper.h.

19  {
20  TOP,
21  OR,
22  XOR,
23  AND,
24  OTHER
25  };

Constructor & Destructor Documentation

edm::DocFormatHelper::DocFormatHelper ( )
inline

Definition at line 27 of file DocFormatHelper.h.

27  :
28  brief_(false),
29  lineWidth_(80),
30  indentation_(4),
31  startColumn2_(24U),
32  section_(),
33  pass_(0),
34  column1_(0),
35  column2_(0),
36  column3_(0),
37  counter_(0),
38  parent_(OTHER)
39  { }
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:105

Member Function Documentation

bool edm::DocFormatHelper::brief ( ) const
inline

Definition at line 43 of file DocFormatHelper.h.

References brief_.

Referenced by edm::ParameterSetDescription::print(), edm::EmptyGroupDescription::print_(), edm::AllowedLabelsDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::AllowedLabelsDescriptionBase::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

43 { return brief_; }
size_t edm::DocFormatHelper::column1 ( ) const
inline

Definition at line 58 of file DocFormatHelper.h.

References column1_.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

58 { return column1_; }
size_t edm::DocFormatHelper::column2 ( ) const
inline

Definition at line 59 of file DocFormatHelper.h.

References column2_.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

59 { return column2_; }
size_t edm::DocFormatHelper::column3 ( ) const
inline

Definition at line 60 of file DocFormatHelper.h.

References column3_.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

60 { return column3_; }
size_t edm::DocFormatHelper::commentWidth ( ) const

Definition at line 125 of file DocFormatHelper.cc.

References lineWidth(), startColumn2(), and create_public_lumi_plots::width.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::XORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

125  {
126 
127  // Make the length of a comment at least 30 characters
128  // per line, longer if there is more space available
129  size_t width = 30U;
130  if (lineWidth() > startColumn2() + 30U) {
131  width = lineWidth() - startColumn2();
132  }
133  return width;
134  }
create_public_lumi_plots.width
int width
Definition: create_public_lumi_plots.py:1008
edm::DocFormatHelper::startColumn2
int startColumn2() const
Definition: DocFormatHelper.h:46
edm::DocFormatHelper::lineWidth
size_t lineWidth() const
Definition: DocFormatHelper.h:44
int edm::DocFormatHelper::counter ( ) const
inline

Definition at line 66 of file DocFormatHelper.h.

References counter_.

Referenced by counter.Counters::__getitem__(), edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::ParameterDescription< ParameterSetDescription >::printDefault_(), edm::ParameterDescription< std::vector< ParameterSet > >::printDefault_(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

66 { return counter_; }
void edm::DocFormatHelper::decrementCounter ( )
inline

Definition at line 69 of file DocFormatHelper.h.

References counter_.

Referenced by edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), and edm::XORGroupDescription::printNestedContent_().

69 { --counter_; }
void edm::DocFormatHelper::incrementCounter ( )
inline

Definition at line 68 of file DocFormatHelper.h.

References counter_.

Referenced by edm::ParameterDescriptionNode::print(), and edm::ParameterDescriptionNode::printNestedContent().

68 { ++counter_; }
void edm::DocFormatHelper::indent ( std::ostream &  os) const

Definition at line 136 of file DocFormatHelper.cc.

References indentation_.

Referenced by edm::ParameterSetDescription::print(), edm::EmptyGroupDescription::print_(), edm::AllowedLabelsDescriptionBase::print_(), edm::XORGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterSwitchBase::printCase(), edm::ParameterSwitch< T >::printNestedContent_(), edm::AllowedLabelsDescriptionBase::printNestedContentBase_(), and wrapAndPrintText().

136  {
137  char oldFill = os.fill();
138  os << std::setfill(' ') << std::setw(indentation_) << "";
139  os.fill(oldFill);
140  }
void edm::DocFormatHelper::indent2 ( std::ostream &  os) const

Definition at line 142 of file DocFormatHelper.cc.

References startColumn2_.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

142  {
143  char oldFill = os.fill();
144  os << std::setfill(' ') << std::setw(startColumn2_) << "";
145  os.fill(oldFill);
146  }
int edm::DocFormatHelper::indentation ( ) const
inline

Definition at line 45 of file DocFormatHelper.h.

References indentation_.

Referenced by edm::ParameterDescriptionBase::printDefault_(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

45 { return indentation_; }
void edm::DocFormatHelper::init ( void  )

Definition at line 115 of file DocFormatHelper.cc.

References column1_, column2_, column3_, counter_, OTHER, parent_, pass_, section_, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::ANDGroupDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

115  {
116  section_ = std::string();
117  pass_ = 0;
118  column1_ = 0;
119  column2_ = 0;
120  column3_ = 0;
121  counter_ = 0;
122  parent_ = OTHER;
123  }
AlCaHLTBitMon_QueryRunRegistry.string
string string
Definition: AlCaHLTBitMon_QueryRunRegistry.py:255
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:105
size_t edm::DocFormatHelper::lineWidth ( ) const
inline

Definition at line 44 of file DocFormatHelper.h.

References lineWidth_.

Referenced by commentWidth().

44 { return lineWidth_; }
static int edm::DocFormatHelper::offsetModuleLabel ( )
inlinestatic

Definition at line 84 of file DocFormatHelper.h.

Referenced by edm::ConfigurationDescriptions::print().

84 { return 2; }
static int edm::DocFormatHelper::offsetSectionContent ( )
inlinestatic

Definition at line 86 of file DocFormatHelper.h.

Referenced by edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

86 { return 4; }
static int edm::DocFormatHelper::offsetTopLevelPSet ( )
inlinestatic

Definition at line 85 of file DocFormatHelper.h.

Referenced by edm::ConfigurationDescriptions::printForLabel().

85 { return 2; }
DescriptionParent edm::DocFormatHelper::parent ( void  ) const
inline

Definition at line 71 of file DocFormatHelper.h.

References parent_.

Referenced by BeautifulSoup.PageElement::_invert(), Vispa.Gui.ConnectableWidget.ConnectableWidget::addMenuEntry(), Vispa.Views.LineDecayView.LineDecayContainer::applyFilter(), Vispa.Views.BoxDecayView.BoxDecayContainer::arrangeUsingRelations(), Vispa.Views.BoxDecayView.BoxDecayContainer::autolayoutAlgorithm(), Vispa.Gui.ZoomableScrollableWidgetOwner.ZoomableScrollableWidgetOwner::autosizeScrollArea(), Vispa.Views.BoxDecayView.BoxDecayContainer::autosizeScrollArea(), Vispa.Gui.PortWidget.PortWidget::connectionPoint(), Vispa.Main.StartupScreen.StartupScreen::createDescriptionWidget(), Vispa.Views.BoxDecayView.BoxDecayContainer::dataAccessor(), Vispa.Views.LineDecayView.LineDecayContainer::dataAccessor(), Vispa.Views.LineDecayView.LineDecayContainer::delete(), Vispa.Gui.VispaWidget.VispaWidget::delete(), Vispa.Gui.VispaWidget.VispaWidget::dragWidget(), Vispa.Share.ImageExporter.ImageExporter::exportImageDialog(), Vispa.Gui.VispaWidget.VispaWidget::keyPressEvent(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.ConnectableWidget.ConnectableWidget::leaveEvent(), Vispa.Gui.PortWidget.PortWidget::moduleParent(), Vispa.Gui.WidgetContainer.WidgetContainer::mouseDoubleClickEvent(), Vispa.Gui.VispaWidget.VispaWidget::mouseDoubleClickEvent(), Vispa.Gui.PortConnection.PointToPointConnection::mousePressEvent(), Vispa.Gui.VispaWidget.VispaWidget::mousePressEvent(), Vispa.Views.LineDecayView.ParticleWidget::mousePressEvent(), Vispa.Views.LineDecayView.LineDecayContainer::noDecorationsMode(), Vispa.Views.LineDecayView.LineDecayContainer::operationId(), Vispa.Gui.VispaWidget.VispaWidget::paintEvent(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), edm::AllowedLabelsDescriptionBase::printNestedContentBase_(), Vispa.Views.WidgetView.WidgetView::restoreSelection(), Vispa.Views.WidgetView.WidgetView::select(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), Vispa.Views.LineDecayView.LineDecayContainer::sizeHint(), Vispa.Views.LineDecayView.LineDecayContainer::tabController(), Vispa.Views.BoxDecayView.BoxDecayContainer::toggleCollapsed(), Vispa.Views.PropertyView.PropertyView::valueChanged(), Vispa.Views.BoxDecayView.BoxDecayContainer::widgetByObject(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::widgetDoubleClicked(), and Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::widgetDragged().

71 { return parent_; }
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:105
int edm::DocFormatHelper::pass ( ) const
inline

Definition at line 55 of file DocFormatHelper.h.

References pass_.

Referenced by edm::EmptyGroupDescription::print_(), edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterSwitchBase::printCase(), and edm::ParameterSetDescription::printNode().

55 { return pass_; }
std::string const& edm::DocFormatHelper::section ( ) const
inline

Definition at line 52 of file DocFormatHelper.h.

References section_.

Referenced by VarParsing.VarParsing::parseArguments(), edm::AllowedLabelsDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::ParameterDescription< ParameterSetDescription >::printDefault_(), edm::ParameterDescription< std::vector< ParameterSet > >::printDefault_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

52 { return section_; }
void edm::DocFormatHelper::setAtLeast1 ( size_t  width)
inline

Definition at line 62 of file DocFormatHelper.h.

References column1_, and create_public_lumi_plots::width.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

62 { if (width > column1_) column1_ = width; }
create_public_lumi_plots.width
int width
Definition: create_public_lumi_plots.py:1008
void edm::DocFormatHelper::setAtLeast2 ( size_t  width)
inline

Definition at line 63 of file DocFormatHelper.h.

References column2_, and create_public_lumi_plots::width.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

63 { if (width > column2_) column2_ = width; }
create_public_lumi_plots.width
int width
Definition: create_public_lumi_plots.py:1008
void edm::DocFormatHelper::setAtLeast3 ( size_t  width)
inline

Definition at line 64 of file DocFormatHelper.h.

References column3_, and create_public_lumi_plots::width.

Referenced by edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

64 { if (width > column3_) column3_ = width; }
create_public_lumi_plots.width
int width
Definition: create_public_lumi_plots.py:1008
void edm::DocFormatHelper::setBrief ( bool  value)
inline

Definition at line 48 of file DocFormatHelper.h.

References brief_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel().

48 { brief_ = value; }
void edm::DocFormatHelper::setCounter ( int  value)
inline

Definition at line 67 of file DocFormatHelper.h.

References counter_, and relativeConstraints::value.

Referenced by edm::ParameterSetDescription::print(), edm::XORGroupDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), and edm::ParameterSwitch< T >::printNestedContent_().

67 { counter_ = value; }
void edm::DocFormatHelper::setIndentation ( int  value)
inline

Definition at line 50 of file DocFormatHelper.h.

References indentation_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), and edm::ParameterSwitchBase::printNestedContentBase().

50 { indentation_ = value; }
void edm::DocFormatHelper::setLineWidth ( size_t  value)
inline

Definition at line 49 of file DocFormatHelper.h.

References lineWidth_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel().

49 { lineWidth_ = value; }
void edm::DocFormatHelper::setParent ( DescriptionParent  value)
inline

Definition at line 72 of file DocFormatHelper.h.

References parent_, and relativeConstraints::value.

Referenced by lumiQTWidget.LumiCanvas::__init__(), edm::ConfigurationDescriptions::printForLabel(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), and edm::ParameterSwitchBase::printNestedContentBase().

72 { parent_ = value; }
edm::DocFormatHelper::parent_
DescriptionParent parent_
Definition: DocFormatHelper.h:105
void edm::DocFormatHelper::setPass ( int  value)
inline

Definition at line 56 of file DocFormatHelper.h.

References pass_, and relativeConstraints::value.

Referenced by edm::ParameterSetDescription::print(), edm::XORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ParameterSwitch< T >::printNestedContent_(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

56 { pass_ = value; }
void edm::DocFormatHelper::setSection ( std::string const &  value)
inline

Definition at line 53 of file DocFormatHelper.h.

References section_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), and edm::ParameterSwitchBase::printNestedContentBase().

53 { section_ = value; }
int edm::DocFormatHelper::startColumn2 ( ) const
inline

Definition at line 46 of file DocFormatHelper.h.

References startColumn2_.

Referenced by commentWidth(), edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), and edm::ParameterDescriptionBase::printDefault_().

46 { return startColumn2_; }
void edm::DocFormatHelper::wrapAndPrintText ( std::ostream &  os,
std::string const &  text,
size_t  indent,
size_t  suggestedWidth 
)
static

Definition at line 98 of file DocFormatHelper.cc.

References indent().

Referenced by edm::ConfigurationDescriptions::print(), edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::XORGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), edm::ParameterSwitchBase::printBase(), and edm::ConfigurationDescriptions::printForLabel().

101  {
102 
103  size_t pos = text.find_first_of('\n');
104  if (pos == std::string::npos) {
105  // no embedded newlines
106  wrapAndPrintLine(os, text, indent, suggestedWidth);
107  } else {
108  // print the first line.
109  wrapAndPrintLine(os, text.substr(0, pos), indent, suggestedWidth);
110  // print all lines after the first.
111  wrapAndPrintText(os, text.substr(pos + 1), indent, suggestedWidth);
112  }
113  }
edm::DocFormatHelper::wrapAndPrintText
static void wrapAndPrintText(std::ostream &os, std::string const &text, size_t indent, size_t suggestedWidth)
Definition: DocFormatHelper.cc:98
runonSM.text
tuple text
Definition: runonSM.py:42
edm::DocFormatHelper::indent
void indent(std::ostream &os) const
Definition: DocFormatHelper.cc:136

Member Data Documentation

bool edm::DocFormatHelper::brief_
private

Definition at line 90 of file DocFormatHelper.h.

Referenced by brief(), and setBrief().

size_t edm::DocFormatHelper::column1_
private

Definition at line 99 of file DocFormatHelper.h.

Referenced by column1(), init(), and setAtLeast1().

size_t edm::DocFormatHelper::column2_
private

Definition at line 100 of file DocFormatHelper.h.

Referenced by column2(), init(), and setAtLeast2().

size_t edm::DocFormatHelper::column3_
private

Definition at line 101 of file DocFormatHelper.h.

Referenced by column3(), init(), and setAtLeast3().

int edm::DocFormatHelper::counter_
private

Definition at line 103 of file DocFormatHelper.h.

Referenced by counter(), decrementCounter(), incrementCounter(), init(), and setCounter().

int edm::DocFormatHelper::indentation_
private

Definition at line 92 of file DocFormatHelper.h.

Referenced by indent(), indentation(), and setIndentation().

size_t edm::DocFormatHelper::lineWidth_
private

Definition at line 91 of file DocFormatHelper.h.

Referenced by lineWidth(), and setLineWidth().

DescriptionParent edm::DocFormatHelper::parent_
private

Definition at line 105 of file DocFormatHelper.h.

Referenced by init(), parent(), and setParent().

int edm::DocFormatHelper::pass_
private

Definition at line 97 of file DocFormatHelper.h.

Referenced by init(), pass(), and setPass().

std::string edm::DocFormatHelper::section_
private

Definition at line 95 of file DocFormatHelper.h.

Referenced by init(), section(), and setSection().

size_t edm::DocFormatHelper::startColumn2_
private

Definition at line 93 of file DocFormatHelper.h.

Referenced by indent2(), and startColumn2().

Generated for CMSSW Reference Manual by doxygen 1.8.5