ROOT  6.07/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
RooPrintable Class Reference
RooFitCore

RooPlotable is a 'mix-in' base class that define the standard RooFit plotting and printing methods.

Each RooPlotable implementation must define methods that print the objects name, class name, title, value, arguments and extras to a provided stream. The definition of value is class dependent. The definition of arguments is also class dependent, but should always be interpreted as the names (and properties) of any (RooAbsArg) external inputs of a given object. The extras method can be used to print any properties that does not fit in any of the other classes. Each object an also override the definitions made in defaultPrintStyle and defaultPrintContents to determine what is printed (in terms of contents) and how it is printed (inline,single-line or multiline) given a Print() option string.

Definition at line 26 of file RooPrintable.h.

Public Types

enum  ContentsOption {
  kName =1, kClassName =2, kValue =4, kArgs =8,
  kExtras =16, kAddress =32, kTitle =64, kCollectionHeader =128
}
 
enum  StyleOption {
  kInline =1, kSingleLine =2, kStandard =3, kVerbose =4,
  kTreeStructure =5
}
 

Public Member Functions

 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual void printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
 Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'. More...
 
virtual void printAddress (std::ostream &os) const
 Print class name of object. More...
 
virtual void printName (std::ostream &os) const
 Print name of object. More...
 
virtual void printTitle (std::ostream &os) const
 Print title of object. More...
 
virtual void printClassName (std::ostream &os) const
 Print class name of object. More...
 
virtual void printValue (std::ostream &os) const
 Interface to print value of object. More...
 
virtual void printArgs (std::ostream &os) const
 Interface for printing of object arguments. More...
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object. More...
 
virtual void printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
 Interface for detailed printing of object. More...
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object. More...
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Default choice of contents to be printed (name and value) More...
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 

Static Public Member Functions

static std::ostream & defaultPrintStream (std::ostream *os=0)
 Return a reference to the current default stream to use in Print(). More...
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. More...
 

Static Protected Attributes

static Int_t _nameLength
 

#include <RooPrintable.h>

Inheritance diagram for RooPrintable:
[legend]

Member Enumeration Documentation

enum RooPrintable::ContentsOption
Enumerator
kName 
kClassName 
kValue 
kArgs 
kExtras 
kAddress 
kTitle 
kCollectionHeader 

Definition at line 34 of file RooPrintable.h.

enum RooPrintable::StyleOption
Enumerator
kInline 
kSingleLine 
kStandard 
kVerbose 
kTreeStructure 

Definition at line 35 of file RooPrintable.h.

Constructor & Destructor Documentation

RooPrintable::RooPrintable ( )
inline

Definition at line 28 of file RooPrintable.h.

virtual RooPrintable::~RooPrintable ( )
inlinevirtual

Definition at line 29 of file RooPrintable.h.

Member Function Documentation

Int_t RooPrintable::defaultPrintContents ( Option_t *  opt) const
virtual

Default choice of contents to be printed (name and value)

Reimplemented in RooAbsArg, RooAbsData, RooAbsCollection, RooPlot, RooRealVar, RooAbsDataStore, RooFitResult, RooAbsGenContext, and Roo1DTable.

Definition at line 233 of file RooPrintable.cxx.

Referenced by RooFit::operator<<(), RooEllipse::Print(), RooGrid::Print(), RooNameSet::Print(), RooNumGenConfig::Print(), RooAbsNumGenerator::Print(), RooCurve::Print(), RooHist::Print(), RooFormula::Print(), RooAbsBinning::Print(), RooCustomizer::Print(), RooNumIntConfig::Print(), and RooCatType::Print().

ostream & RooPrintable::defaultPrintStream ( std::ostream *  os = 0)
static

Return a reference to the current default stream to use in Print().

Use the optional parameter to specify a new default stream (a reference to the old one is still returned). This method allows subclasses to provide an inline implementation of Print() without pulling in iostream.h.

Definition at line 272 of file RooPrintable.cxx.

Referenced by RooStats::ModelConfig::GuessObsAndNuisance(), RooEllipse::Print(), RooGrid::Print(), RooNameSet::Print(), RooNumGenConfig::Print(), RooAbsGenContext::Print(), Roo1DTable::Print(), RooAbsNumGenerator::Print(), RooCurve::Print(), RooHist::Print(), RooFitResult::Print(), RooFormula::Print(), RooAbsBinning::Print(), RooCustomizer::Print(), RooNumIntConfig::Print(), RooAbsDataStore::Print(), RooCatType::Print(), RooAbsCollection::Print(), RooPlot::Print(), RooAbsData::Print(), RooAbsArg::Print(), and RooStats::ModelConfig::Print().

RooPrintable::StyleOption RooPrintable::defaultPrintStyle ( Option_t *  opt) const
virtual

Reimplemented in RooFitResult, RooNumIntConfig, RooAbsGenContext, and RooNumGenConfig.

Definition at line 241 of file RooPrintable.cxx.

Referenced by RooFitResult::defaultPrintStyle(), RooEllipse::Print(), RooGrid::Print(), RooNameSet::Print(), Roo1DTable::Print(), RooAbsNumGenerator::Print(), RooCurve::Print(), RooHist::Print(), RooFormula::Print(), RooAbsBinning::Print(), RooCustomizer::Print(), RooAbsDataStore::Print(), RooCatType::Print(), RooAbsCollection::Print(), RooPlot::Print(), RooAbsData::Print(), and RooAbsArg::Print().

void RooPrintable::nameFieldLength ( Int_t  newLen)
static

Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.

Definition at line 63 of file RooPrintable.cxx.

Referenced by RooAbsCollection::printMultiline().

void RooPrintable::printAddress ( std::ostream &  os) const
virtual

Print class name of object.

Reimplemented in RooAbsArg.

Definition at line 223 of file RooPrintable.cxx.

void RooPrintable::printArgs ( std::ostream &  os) const
virtual

Interface for printing of object arguments.

Arguments are loosely defined as external server objects in this context

Reimplemented in RooCFunction3PdfBinding< VO, VI1, VI2, VI3 >, RooCFunction4PdfBinding< VO, VI1, VI2, VI3, VI4 >, RooCFunction2PdfBinding< VO, VI1, VI2 >, RooCFunction1PdfBinding< VO, VI >, RooCFunction3Binding< VO, VI1, VI2, VI3 >, RooCFunction2Binding< VO, VI1, VI2 >, RooAbsArg, RooCFunction4Binding< VO, VI1, VI2, VI3, VI4 >, RooCFunction1Binding< VO, VI >, RooDataSet, RooDataHist, RooPlot, RooAbsDataStore, RooAbsBinning, RooFunctorPdfBinding, RooFunctor1DPdfBinding, RooCustomizer, RooAbsNumGenerator, RooFitResult, RooFormula, RooAbsGenContext, RooFunctor1DBinding, RooFunctorBinding, RooTFnBinding, and RooTFnPdfBinding.

Definition at line 190 of file RooPrintable.cxx.

void RooPrintable::printClassName ( std::ostream &  os) const
virtual

Print class name of object.

Reimplemented in RooAbsArg, RooAbsData, RooAbsCollection, RooPlot, RooCatType, RooAbsDataStore, RooAbsBinning, RooCustomizer, RooAbsNumGenerator, RooFitResult, RooFormula, RooAbsGenContext, RooHist, RooCurve, Roo1DTable, RooNameSet, RooGrid, and RooEllipse.

Definition at line 214 of file RooPrintable.cxx.

void RooPrintable::printExtras ( std::ostream &  os) const
virtual

Interface to print extras of object.

Reimplemented in RooRealVar.

Definition at line 163 of file RooPrintable.cxx.

void RooPrintable::printMultiline ( std::ostream &  os,
Int_t  contents,
Bool_t  verbose = kFALSE,
TString  indent = "" 
) const
virtual

Interface for detailed printing of object.

Reimplemented in RooAbsReal, RooAbsArg, RooAbsPdf, RooAbsData, RooAbsCollection, RooDataSet, RooPlot, RooDataHist, RooRealVar, RooAbsRealLValue, RooAbsDataStore, RooAbsCategory, RooCustomizer, RooNumIntConfig, RooFitResult, RooFormula, RooAbsGenContext, RooHist, RooCurve, RooStats::HistFactory::FlexibleInterpVar, RooResolutionModel, RooFormulaVar, RooParamBinning, RooPlotable, Roo1DTable, RooNumGenConfig, RooRealIntegral, RooAbsAnaConvPdf, RooConvGenContext, RooAddGenContext, RooBinnedGenContext, RooMappedCategory, RooGenericPdf, RooSuperCategory, RooProdGenContext, RooThresholdCategory, RooSimGenContext, RooGenContext, RooMultiCategory, RooSimSplitGenContext, RooBinningCategory, RooGrid, and RooEllipse.

Definition at line 171 of file RooPrintable.cxx.

void RooPrintable::printName ( std::ostream &  os) const
virtual

Print name of object.

Reimplemented in RooAbsArg, RooAbsData, RooAbsCollection, RooPlot, RooCatType, RooAbsDataStore, RooAbsBinning, RooCustomizer, RooAbsNumGenerator, RooFitResult, RooFormula, RooAbsGenContext, RooHist, RooCurve, Roo1DTable, RooNameSet, RooGrid, and RooEllipse.

Definition at line 198 of file RooPrintable.cxx.

void RooPrintable::printStream ( std::ostream &  os,
Int_t  contents,
StyleOption  style,
TString  indent = "" 
) const
virtual

Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'.

Each message is prefixed by string 'indent' when printed

Definition at line 75 of file RooPrintable.cxx.

Referenced by RooAbsReal::createPlotProjection(), RooStats::ProfileLikelihoodCalculator::DoGlobalFit(), RooSuperCategory::evaluate(), RooStats::ProfileLikelihoodCalculator::GetHypoTest(), RooAbsReal::logEvalError(), RooAbsCategory::lookupType(), RooFit::operator<<(), RooAbsReal::plotOn(), RooEllipse::Print(), RooGrid::Print(), RooNameSet::Print(), RooArgProxy::print(), RooNumGenConfig::Print(), RooListProxy::print(), RooAbsGenContext::Print(), Roo1DTable::Print(), RooAbsNumGenerator::Print(), RooSetProxy::print(), RooCurve::Print(), RooHist::Print(), RooFitResult::Print(), RooFormula::Print(), RooAbsBinning::Print(), RooCustomizer::Print(), RooNumIntConfig::Print(), RooAbsDataStore::Print(), RooCatType::Print(), RooAbsCollection::Print(), RooPlot::Print(), RooAbsData::Print(), RooAbsArg::Print(), RooPlot::printArgs(), RooAbsCachedPdf::PdfCacheElem::printCompactTreeHook(), RooBinningCategory::printMultiline(), RooGenContext::printMultiline(), RooMultiCategory::printMultiline(), RooSimSplitGenContext::printMultiline(), RooSimGenContext::printMultiline(), RooProdGenContext::printMultiline(), RooThresholdCategory::printMultiline(), RooMappedCategory::printMultiline(), RooBinnedGenContext::printMultiline(), RooAddGenContext::printMultiline(), RooRealIntegral::printMultiline(), RooResolutionModel::printMultiline(), RooAbsCategory::printMultiline(), RooAbsDataStore::printMultiline(), RooDataHist::printMultiline(), RooPlot::printMultiline(), RooAbsCollection::printMultiline(), RooAbsPdf::printMultiline(), RooAbsArg::printMultiline(), RooPlot::printValue(), RooAcceptReject::RooAcceptReject(), RooRealMPFE::serverLoop(), RooAbsPdf::syncNormalization(), and RooAddModel::updateCoefficients().

void RooPrintable::printTitle ( std::ostream &  os) const
virtual

Print title of object.

Reimplemented in RooAbsArg, RooAbsData, RooAbsCollection, RooPlot, RooCatType, RooAbsDataStore, RooAbsBinning, RooCustomizer, RooAbsNumGenerator, RooFitResult, RooFormula, RooAbsGenContext, RooHist, RooCurve, Roo1DTable, RooNameSet, RooGrid, and RooEllipse.

Definition at line 206 of file RooPrintable.cxx.

void RooPrintable::printTree ( std::ostream &  os,
TString  indent = "" 
) const
virtual

Interface for tree structure printing of object.

Reimplemented in RooAbsArg.

Definition at line 179 of file RooPrintable.cxx.

void RooPrintable::printValue ( std::ostream &  os) const
virtual

Interface to print value of object.

Reimplemented in RooAbsReal, RooAbsPdf, RooDataSet, RooAbsCollection, RooDataHist, RooPlot, RooRealVar, RooAbsDataStore, RooCatType, RooAbsBinning, RooAbsCategory, RooFitResult, RooFormula, Roo1DTable, RooAbsString, RooNameSet, and RooAbsHiddenReal.

Definition at line 155 of file RooPrintable.cxx.

Referenced by RooWorkspace::Print(), and RooAbsArg::printCompactTree().

Member Data Documentation

Int_t RooPrintable::_nameLength
staticprotected

Definition at line 58 of file RooPrintable.h.

Referenced by RooAbsCollection::printMultiline().

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