Gaudi::Utils Namespace Reference

Namespaces
	Histos
	Collection of useful utilities for manipulations with AIDA hisgograms.
	QuasiRandom
	RegEx
	RegeEx: nemspace to hold gaudi regular expression checking.

Classes
struct	_GetType
	Helper structure to define the proper return type for "get"-functions. More...
struct	_GetType< Gaudi::NamedRange_< CONTAINER > >
	the template specialization for "named ranges" More...
struct	_GetType< Gaudi::Range_< CONTAINER > >
	the template specialization for "ranges" More...
struct	_GetType< TYPE & >
	the template specialization for references More...
struct	_GetType< TYPE * >
	the template specialization for pointers More...
class	Aida2ROOT
	Accessor to underlying ROOT-representation of transient histograms The actual code is imported from Bender project. More...
class	AlgContext
	Helper "sentry" class to automatize the safe register/unregister the algorithm's context. More...
class	AlgNameSelector
	The trivial selector of algorithm by type. More...
class	AlgSelector
	Simple interface class for selection of algorithms. More...
class	AlgTypeSelector
	The trivial selector of algorithm by type. More...
struct	CheckData
	Helper structure for implementation of "exists"-functions for GaudiCommon<BASE> More...
struct	CheckData< const TYPE >
	the template specialization for 'const'-type More...
struct	CheckData< Gaudi::NamedRange_< std::vector< const TYPE * > > >
	the template specialization for ranges More...
struct	CheckData< Gaudi::Range_< std::vector< const TYPE * > > >
	the template specialization for ranges More...
struct	CheckData< TYPE & >
	the template specialization for reference types More...
struct	CheckData< TYPE * >
	the template specialization for pointer types More...
struct	GetData
	Helper structure for implementation of "get"-functions for GaudiCommon<BASE> More...
struct	GetData< const TYPE >
	the template specialization for const types More...
struct	GetData< Gaudi::NamedRange_< std::vector< const TYPE * > > >
	the template specialization for named ranges More...
struct	GetData< Gaudi::Range_< std::vector< const TYPE * > > >
	the template specialization for ranges More...
struct	GetData< TYPE & >
	the template specialization for reference types More...
struct	GetData< TYPE * >
	the template specialization for pointer types More...
struct	GetOrCreateData
	Helper structure for implementation of "getOrCreate"-functions for GaudiCommon<BASE> More...
struct	GetOrCreateData< const TYPE, const TYPE2 >
struct	GetOrCreateData< const TYPE, TYPE2 >
struct	GetOrCreateData< Gaudi::NamedRange_< std::vector< const TYPE * > >, TYPE2 >
struct	GetOrCreateData< Gaudi::Range_< std::vector< const TYPE * > >, TYPE2 >
struct	GetOrCreateData< TYPE &, TYPE2 & >
struct	GetOrCreateData< TYPE &, TYPE2 >
struct	GetOrCreateData< TYPE *, TYPE2 * >
struct	GetOrCreateData< TYPE *, TYPE2 >
struct	GetOrCreateData< TYPE, const TYPE2 >
struct	GetOrCreateData< TYPE, TYPE2 & >
struct	GetOrCreateData< TYPE, TYPE2 * >
class	HistoStats
	The collection of trivial functions to access the statistical information for the histograms. More...
class	LockedChrono
	Helper object, useful for measurement of CPU-performance of highly-recursive structures, e.g. More...
class	MapBase
	Helper base-class to allow the generic Python-decoration for all "map-like" classes in Gaudi. More...
struct	PropertyTypeTraits
	helper structure to define the types for properties More...
struct	PropertyTypeTraits< boost::array< T, N > >
	the specialization of property-traits for class boost::array to take care the non-trivial assignements and constructors for this class More...
struct	PropertyTypeTraits< char(&)[N]>
	specialisation for C-strings More...
struct	PropertyTypeTraits< const T(&)[N]>
	specialiation for const-arrays More...
struct	PropertyTypeTraits< std::array< T, N > >
	the specialization of property-traits for class std::array to take care the non-trivial assignements and constructors for this class More...
struct	PropertyTypeTraits< T(&)[N]>
struct	PropertyTypeTraits< T[N]>
	specialization for arrays More...
class	SignalMonitorSvc
	Implementation of Gaudi::ISignalMonitor. More...
class	StopSignalHandler
	Service that stop the processing if a signal is received. More...
struct	TuplePrinter
struct	TuplePrinter< Tuple, 1 >
class	TypeNameString
	Helper class to parse a string of format "type/name". More...

Functions
GAUDI_API IAlgorithm *	getAlgorithm (const IAlgContextSvc *svc, const AlgSelector &sel)
	simple function to get the algorithm from Context Service More...
GAUDI_API IAlgorithm *	getAlgorithm (const std::vector< IAlgorithm * > &lst, const AlgSelector &sel)
	simple function to get the algorithm from Context Service More...
GAUDI_API GaudiAlgorithm *	getGaudiAlg (const IAlgContextSvc *svc)
	simple function to extract the last active GaudiAlgorithm from the context More...
GAUDI_API GaudiHistoAlg *	getHistoAlg (const IAlgContextSvc *svc)
	simple function to extract the last active GaudiHistoAlg from the context More...
GAUDI_API GaudiTupleAlg *	getTupleAlg (const IAlgContextSvc *svc)
	simple function to extract the last active GaudiTupleAlg from the context More...
GAUDI_API GaudiSequencer *	getGaudiSequencer (const IAlgContextSvc *svc)
	simple function to extract the last active GaudiSequencer from the context More...
GAUDI_API Sequencer *	getSequencerAlg (const IAlgContextSvc *svc)
	simple function to extract the last active Sequencer from the context More...
GAUDI_API IAlgorithm *	getSequencer (const IAlgContextSvc *svc)
	simple function to extract the last active "Sequencer" () GaudiSequencer or simple Sequencer) from the context More...
template<class TYPE >
_GetType< TYPE >::return_type	getFromTS (IDataProviderSvc *service, const std::string &location)
	Helper function to provide the minimal lookup and cast functionality of SmartDataPtr used in the helper classes. More...
template<class ITERATOR >
std::ostream &	toStream (ITERATOR first,ITERATOR last,std::ostream &s,const std::string &open,const std::string &close,const std::string &delim)
	the helper function to print the sequence More...
template<class TYPE , std::size_t N>
std::ostream &	toStream (const boost::array< TYPE, N > &obj, std::ostream &s)
	printout of class boost::array The format is "Python's tuple" More...
GAUDI_API std::ostream &	toStream (const DataHandle &v, std::ostream &o)
GAUDI_API std::ostream &	toStream (const DataObjID &v, std::ostream &o)
GAUDI_API std::ostream &	toStream (const DataObjIDColl &v, std::ostream &o)
GAUDI_API bool	hasProperty (const IProperty *p, const std::string &name)
	simple function which check the existence of the property with the given name. More...
GAUDI_API bool	hasProperty (const IInterface *p, const std::string &name)
	simple function which check the existence of the property with the given name. More...
GAUDI_API Property *	getProperty (const IProperty *p, const std::string &name)
	simple function which gets the property with given name from the component More...
GAUDI_API Property *	getProperty (const IInterface *p, const std::string &name)
	simple function which gets the property with given name from the component More...
GAUDI_API bool	hasProperty (const std::vector< const Property * > *p, const std::string &name)
	check the property by name from the list of the properties More...
GAUDI_API const Property *	getProperty (const std::vector< const Property * > *p, const std::string &name)
	get the property by name from the list of the properties More...
template<class TYPE >
StatusCode	setProperty (IProperty *component, const std::string &name, const TYPE &value, const std::string &doc)
	simple function to set the property of the given object from the value More...
template<class TYPE >
StatusCode	setProperty (IProperty *component, const std::string &name, const TYPE &value)
	simple function to set the property of the given object from the value More...
GAUDI_API StatusCode	setProperty (IProperty *component, const std::string &name, const std::string &value, const std::string &doc="")
	the full specialization of the previous method setProperty( IProperty, std::string, const TYPE&) for standard strings More...
GAUDI_API StatusCode	setProperty (IProperty *component, const std::string &name, const char *value, const std::string &doc="")
	the full specialization of the method setProperty( IProperty, std::string, const TYPE&) for C-strings More...
template<unsigned N>
StatusCode	setProperty (IProperty *component, const std::string &name, const char(&value)[N], const std::string &doc="")
	the full specialization of the method setProperty( IProperty, std::string, const TYPE&) for C-arrays More...
GAUDI_API StatusCode	setProperty (IProperty *component, const std::string &name, const Property *property, const std::string &doc="")
	simple function to set the property of the given object from another property More...
GAUDI_API StatusCode	setProperty (IProperty *component, const std::string &name, const Property &property, const std::string &doc="")
	simple function to set the property of the given object from another property More...
template<class TYPE >
StatusCode	setProperty (IProperty *component, const std::string &name, const SimpleProperty< TYPE > &value, const std::string &doc="")
	simple function to set the property of the given object from another property More...
template<class TYPE >
StatusCode	setProperty (IInterface *component, const std::string &name, const TYPE &value, const std::string &doc="")
	simple function to set the property of the given object from the value More...
GAUDI_API StatusCode	setProperty (IInterface *component, const std::string &name, const std::string &value, const std::string &doc="")
	the full specialization of the method setProperty( IInterface , std::string, const TYPE&) for standard strings More...
GAUDI_API StatusCode	setProperty (IInterface *component, const std::string &name, const char *value, const std::string &doc="")
	the full specialization of the method setProperty( IInterface , std::string, const TYPE&) for C-strings More...
template<unsigned N>
StatusCode	setProperty (IInterface *component, const std::string &name, const char(&value)[N], const std::string &doc="")
	the full specialization of the method setProperty( IInterface, std::string, const TYPE&) for C-arrays More...
GAUDI_API StatusCode	setProperty (IInterface *component, const std::string &name, const Property *property, const std::string &doc="")
	simple function to set the property of the given object from another property More...
GAUDI_API StatusCode	setProperty (IInterface *component, const std::string &name, const Property &property, const std::string &doc="")
	simple function to set the property of the given object from another property More...
template<class TYPE >
StatusCode	setProperty (IInterface *component, const std::string &name, const SimpleProperty< TYPE > &value, const std::string &doc="")
	simple function to set the property of the given object from another property More...
GAUDI_API std::string	formatAsTableRow (const StatEntity &counter, const bool flag, const std::string &format1=" |%|7d| |%|11.7g| |%|#11.5g| |%|#10.5g| |%|#10.5g| |%|#10.5g| |", const std::string &format2="*|%|7d| |%|11.5g| |(%|#9.7g| +- %|-#8.6g|)%%| ----- | ----- |")
	print the counter in a form of the table row More...
GAUDI_API std::string	formatAsTableRow (const std::string &name, const StatEntity &counter, const bool flag=true, const std::string &format1=" %|-15.15s|%|17t||%|7d| |%|11.7g| |%|#11.5g| |%|#10.5g| |%|#10.5g| |%|#10.5g| |", const std::string &format2="*%|-15.15s|%|17t||%|7d| |%|11.5g| |(%|#9.7g| +- %|-#8.6g|)%%| ----- | ----- |")
	print the counter in a form of the table row More...
GAUDI_API std::string	formatAsTableRow (const std::string &name, const std::string &group, const StatEntity &entity, const bool flag=true, const std::string &format1=" %|15.15s|%|-15.15s|%|32t||%|7d| |%|11.7g| |%|#11.5g| |%|#10.5g| |%|#10.5g| |%|#10.5g| |", const std::string &format2="*%|15.15s|%|-15.15s|%|32t||%|7d| |%|11.5g| |(%|#9.7g| +- %|-#8.6g|)%%| ----- | ----- |")
	print the counter in a form of the table row More...
template<class TYPE , std::size_t N>
std::ostream &	toStream (const std::array< TYPE, N > &obj, std::ostream &s)
	printout of class std::array The format is "Python's tuple" More...
GAUDI_API std::ostream &	toStream (const Gaudi::StringKey &key, std::ostream &s)
	send the object to stream (needed to use it as property) More...
template<class SCALAR >
std::ostream &	toStream (const SCALAR &, std::ostream &)
template<class SCALAR , unsigned int N>
std::ostream &	toStream (const ROOT::Math::SVector< SCALAR, N > &obj, std::ostream &s)
	the general streaming function for SVector using python-tupel format More...
template<class TYPE >
std::ostream &	toStream (const TYPE &obj, std::ostream &s)
	the generic implementation of the printout to the std::ostream More...
std::ostream &	toStream (const std::string &obj, std::ostream &s)
	the printtout of the strings. More...
std::ostream &	toStream (const bool obj, std::ostream &s)
	the printout of boolean values "a'la Python" More...
std::ostream &	toStream (const float obj, std::ostream &s, const int prec=6)
	the printout of float values with the reasonable precision More...
std::ostream &	toStream (const double obj, std::ostream &s, const int prec=8)
	the printout of double values with the reasonable precision More...
std::ostream &	toStream (const long double obj, std::ostream &s, const int prec=10)
	the printout of long double values with the reasonable precision More...
template<class KTYPE , class VTYPE >
std::ostream &	toStream (const std::pair< KTYPE, VTYPE > &obj, std::ostream &s)
	the partial template specialization of std::pair<KTYPE,VTYPE> printout the pair is printed a'la Python tuple: " ( a , b )" More...
template<class TYPE , class ALLOCATOR >
std::ostream &	toStream (const std::vector< TYPE, ALLOCATOR > &obj, std::ostream &s)
	the partial template specialization of std::vector<TYPE,ALLOCATOR> printout. More...
template<class TYPE , class ALLOCATOR >
std::ostream &	toStream (const std::list< TYPE, ALLOCATOR > &obj, std::ostream &s)
	the partial template specialization of std::list<TYPE,ALLOCATOR> printout. More...
template<class TYPE , class CMP , class ALLOCATOR >
std::ostream &	toStream (const std::set< TYPE, CMP, ALLOCATOR > &obj, std::ostream &s)
	the partial template specialization of std::set<TYPE,CMP,ALLOCATOR> printout. More...
template<class KTYPE , class VTYPE , class CMP , class ALLOCATOR >
std::ostream &	toStream (const std::map< KTYPE, VTYPE, CMP, ALLOCATOR > &obj, std::ostream &s)
	the partial template specialization of std::map<KTYPE,VTYPE,CMP,ALLOCATOR> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )" More...
template<class KTYPE , class VTYPE , class CMP , class ALLOCATOR >
std::ostream &	toStream (const GaudiUtils::VectorMap< KTYPE, VTYPE, CMP, ALLOCATOR > &obj, std::ostream &s)
	the partial template specialization of GaudiUtils::VectorMap<KTYPE,VTYPE,CMP,ALLOCATOR> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )" More...
template<class KTYPE , class VTYPE , class MAP >
std::ostream &	toStream (const GaudiUtils::Map< KTYPE, VTYPE, MAP > &obj, std::ostream &s)
	the partial template specialization of GaudiUtils::Map<KTYPE,VTYPE,MAP> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )" More...
template<class KTYPE , class VTYPE , class HASH , class MAP >
std::ostream &	toStream (const GaudiUtils::HashMap< KTYPE, VTYPE, HASH, MAP > &obj, std::ostream &s)
	the partial template specialization of GaudiUtils::HashMap<KTYPE,VTYPE,HASH,MAP> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )" More...
template<class TYPE , unsigned int N>
std::ostream &	toStream (TYPE(&obj)[N], std::ostream &s)
	the specialization for C-arrays, a'la python tuple More...
template<class TYPE , unsigned int N>
std::ostream &	toStream (const TYPE(&obj)[N], std::ostream &s)
	the specialization for C-arrays, a'la python tuple More...
template<unsigned int N>
std::ostream &	toStream (char(&obj)[N], std::ostream &s)
	the specialization for C-string, a'la python tuple More...
template<unsigned int N>
std::ostream &	toStream (const char(&obj)[N], std::ostream &s)
	the specialization for C-string, a'la python tuple More...
std::ostream &	toStream (const char *obj, std::ostream &s)
	the specialization for C-string, a'la python tuple More...
template<typename... Args>
std::ostream &	toStream (const std::tuple< Args...> &tuple, std::ostream &s)
	the helper function to print the tuple More...
template<class TYPE >
std::string	toString (const TYPE &obj)
	the generic implementation of the type conversion to the string More...
std::ostream &	operator<< (std::ostream &s, const TypeNameString &tn)
	Output stream operator for TypeNameString instances. More...
GAUDI_API std::ostream &	toStream (const Gaudi::XYZPoint &obj, std::ostream &s)
	print XYZ point More...
GAUDI_API std::ostream &	toStream (const Gaudi::XYZVector &obj, std::ostream &s)
	print XYZ vector More...
GAUDI_API std::ostream &	toStream (const Gaudi::LorentzVector &obj, std::ostream &s)
	print Lorentz vector More...
GAUDI_API std::ostream &	toStream (const TH1D &histo, std::ostream &stream, const bool asXML=false)
	stream the ROOT histogram into output stream More...
GAUDI_API std::ostream &	toStream (const TH2D &histo, std::ostream &stream, const bool asXML=false)
	stream the ROOT histogram into output stream More...
GAUDI_API std::ostream &	toStream (const TH1F &histo, std::ostream &stream, const bool asXML=false)
	stream the ROOT histogram into output stream More...
GAUDI_API std::ostream &	toStream (const TH2F &histo, std::ostream &stream, const bool asXML=false)
	stream the ROOT histogram into output stream More...
GAUDI_API std::ostream &	toStream (const AIDA::IHistogram1D &histo, std::ostream &stream, const bool asXML=false)
	stream the AIDA histogram into output stream More...
GAUDI_API std::ostream &	toStream (const AIDA::IHistogram2D &histo, std::ostream &stream, const bool asXML=false)
	stream the AIDA histogram into output stream More...
GAUDI_API std::string	toString (const TH1D &histo, const bool asXML=false)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const TH2D &histo, const bool asXML=false)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const TH1F &histo, const bool asXML=false)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const TH2F &histo, const bool asXML=false)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const AIDA::IHistogram1D &histo, const bool asXML=false)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const AIDA::IHistogram2D &histo, const bool asXML=false)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const AIDA::IHistogram1D *histo)
	convert the histogram into the string More...
GAUDI_API std::string	toString (AIDA::IHistogram1D *histo)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const TH1D *histo)
	convert the histogram into the string More...
GAUDI_API std::string	toString (TH1D *histo)
	convert the histogram into the string More...
GAUDI_API std::string	toString (const TH2D *histo)
	convert the histogram into the string More...
GAUDI_API std::string	toString (TH2D *histo)
	convert the histogram into the string More...

Function Documentation

GAUDI_API std::string Gaudi::Utils::formatAsTableRow	(	const StatEntity &	counter,
		const bool	flag,
		const std::string &	format1 = " |%|7d| |%|11.7g| |%|#11.5g| |%|#10.5g| |%|#10.5g| |%|#10.5g| |",
		const std::string &	format2 = "*|%|7d| |%|11.5g| |(%|#9.7g| +- %|-#8.6g|)%%|   -----   |   -----   |"
	)

print the counter in a form of the table row

// loop over counters:
for ( ... )
 {
  const StatEntity&  counter = ... ;
  info() << formatAsTableRow( counter , true ) << endmsg ;
 }

The regular counter is printed as 6 fields

• number of entries (long)
• overal sum (double)
• mean value (double)
• RMS (double)
• minimal value (double)
• maximal value (double)

The printout is performed according to the format, described in optional "format1" parameter using Boost Format Library. The incredible flexibility of Boost Format Library allows to customize the overall layout of the table form minor change the format of individual columns to the overall reshuffling of the reformatted columns

If the parameter "flag" is set to true, AND the content of the counter allows the interpretation of the counter as binomial efficiency counter, the printout is performed in a form of 4 numbers:

• number of entries (long)
• overall sum (double)
• binomial efficiency [perCent] (double)
• uncertainty in binomial efficiency [perCent] (double)

The printout is performed according to format, specified by parameter "format2"

See also

http://boost.org/libs/format

Parameters

name	the name associated with the counter
counter	counter to be printed
flag	use the special format for "efficiency" rows
format1	row format for the regular rows
format2	special row format for the "efficiency" rows

Returns

formatted row in the table

Definition at line 299 of file StatEntity.cpp.

{
  using namespace boost::io ;
  if ( flag && 0 <= counter.eff() && 0 <= counter.effErr() )
  {
    boost::format fmt( format2 ) ;
    fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
    fmt
      %   counter.nEntries ()
      %   counter.sum      ()
      % ( counter.eff      () * 100 )
      % ( counter.effErr   () * 100 ) ;
    return fmt.str() ;
  }
  boost::format fmt  ( format1 ) ;
  fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
  fmt
    %   counter.nEntries ()
    %   counter.sum      ()
    %   counter.mean     ()
    %   counter.rms      ()
    %   counter.min      ()
    %   counter.max      () ;
  return fmt.str() ;
}

GAUDI_API std::string Gaudi::Utils::formatAsTableRow	(	const std::string &	name,
		const StatEntity &	counter,
		const bool	flag = true,
		const std::string &	format1 = " %|-15.15s|%|17t||%|7d| |%|11.7g| |%|#11.5g| |%|#10.5g| |%|#10.5g| |%|#10.5g| |",
		const std::string &	format2 = "*%|-15.15s|%|17t||%|7d| |%|11.5g| |(%|#9.7g| +- %|-#8.6g|)%%|   -----   |   -----   |"
	)

print the counter in a form of the table row

std::string header = "     Counter     |     #     |    sum     |" ;
header += " mean/eff^* | rms/err^*  |     min     |     max     |" ;

 info() << header << endmsg ;

  // loop over counters:
  for ( ... )
   {
    const std::string& name    = ... ;
    const StatEntity&  counter = ... ;
    info() << formatAsTableRow( name , counter ) << endmsg ;
   }

The table row for the regular counter is printed as 7 fields

• counter name (string)
• number of entries (long)
• overal sum (double)
• mean value (double)
• RMS (double)
• minimal value (double)
• maximal value (double)

The printout is performed according to the format, described in optional "format1" parameter using Boost Format Library. The incredible flexibility of Boost Format Library allows to customize the overall layout of the table form minor change the format of individual columns to the overall reshuffling of the reformatted columns

If the parameter "flag" is set to true AND the counter name, converted to the lowercase constant one of the substrings: "eff","acc","fltr","filt","pass" AND (of course) the content of the counter allows the interpretation of the counter as the binomial efficiency counter, the printout is performed using 5 fields ("binomial efficiency format")

• counter name (string)
• number of entries (long)
• overall sum (double)
• binomial efficiency [perCent] (double)
• uncertainty in binomial efficiency [perCent] (double)

The printout is performed according to format, specified by parameter "format2"

See also

http://boost.org/libs/format

Parameters

name	the name associated with the counter
counter	counter to be printed
flag	use the special format for "efficiency" rows
format1	row format for the regular rows
format2	special row format for the "efficiency" rows

Returns

formatted row in the table

Definition at line 338 of file StatEntity.cpp.

{
  using namespace boost::io ;
  if ( flag && effCounter ( name ) && 0 <= counter.eff() && 0 <= counter.effErr() )
  {
    boost::format fmt( format2 ) ;
    fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
    fmt
      % ( "\"" + name + "\"" )
      %   counter.nEntries ()
      %   counter.sum      ()
      % ( counter.eff      () * 100 )
      % ( counter.effErr   () * 100 ) ;
    return fmt.str() ;
  }
  boost::format fmt  ( format1 ) ;
  fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
  fmt
    % ( "\"" + name + "\"" )
    %   counter.nEntries ()
    %   counter.sum      ()
    %   counter.mean     ()
    %   counter.rms      ()
    %   counter.min      ()
    %   counter.max      () ;
  return fmt.str() ;
}

GAUDI_API std::string Gaudi::Utils::formatAsTableRow	(	const std::string &	name,
		const std::string &	group,
		const StatEntity &	entity,
		const bool	flag = true,
		const std::string &	format1 = " %|15.15s|%|-15.15s|%|32t||%|7d| |%|11.7g| |%|#11.5g| |%|#10.5g| |%|#10.5g| |%|#10.5g| |",
		const std::string &	format2 = "*%|15.15s|%|-15.15s|%|32t||%|7d| |%|11.5g| |(%|#9.7g| +- %|-#8.6g|)%%|    -----    |   -----   |"
	)

print the counter in a form of the table row

std::string header = "       Counter :: Group         |     #     |";
header += "    sum     | mean/eff^* | rms/err^*  |     min     |";
header += "     max     |") ;

info() << header << endmsg ;

 // loop over counters:
 for ( ... )
  {
   const std::string& name    = ... ;
   const std::string& group   = .. ;
   const StatEntity&  counter = ... ;
   info() << formatAsTableRow ( name , group , counter ) << endmsg ;
  }

The table row for the regular counter is printed as 8 fields

• counter name (string)
• counter group (string)
• number of entries (long)
• overall sum (double)
• mean value (double)
• RMS (double)
• minimal value (double)
• maximal value (double)

The printout is performed according to the format, described in optional "format1" parameter using Boost Format Library. The incredible flexibility of Boost Format Library allows to customize the overall layout of the table form minor change the format of individual columns to the overall reshuffling of the reformatted columns

If the parameter "flag" is set to true AND either the counter name or counter group, converted to the lowercase contains one of the substrings: "eff","acc","fltr","filt","pass" AND (of course) the content of the counter allows the interpretation of the counter as the binomial efficiency counter, the printout is performed using 6 fields ("binomial efficiency format")

• counter name (string)
• counter group (string)
• number of entries (long)
• overall sum (double)
• binomial efficiency [perCent] (double)
• uncertainty in binomial efficiency [perCent] (double)

The printout is performed according to format, specified by parameter "format2"

See also

http://boost.org/libs/format

Parameters

name	the name associated with the counter
group	the group associated with the counter
counter	counter to be printed
flag	use the special format for "efficiency" rows
format1	row format for the regular rows
format2	the special row format for the "efficiency" rows

Returns

formatted row in the table

Definition at line 381 of file StatEntity.cpp.

{
  using namespace boost::io ;
  if ( flag && ( effCounter ( name ) || effCounter ( group ) )
       && 0 <= counter.eff() && 0 <= counter.effErr() )
  {
    boost::format fmt( format2 ) ;
    fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
    fmt
      % ( "\"" + name  + ":"  )
      % ( ":"  + group + "\"" )
      %   counter.nEntries ()
      %   counter.sum      ()
      % ( counter.eff      () * 100 )
      % ( counter.effErr   () * 100 ) ;
    return fmt.str() ;
  }
  boost::format fmt  ( format1 ) ;
  fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
  fmt
    % ( "\""  + name  + ":"  )
    % ( ":"   + group + "\"" )
    %   counter.nEntries ()
    %   counter.sum      ()
    %   counter.mean     ()
    %   counter.rms      ()
    %   counter.min      ()
    %   counter.max      () ;
  return fmt.str() ;
}

GAUDI_API IAlgorithm * Gaudi::Utils::getAlgorithm	(	const IAlgContextSvc *	svc,
		const AlgSelector &	sel
	)

simple function to get the algorithm from Context Service

// get the selector
const AlgSelector& selector = ... ;

// get the context service:
const IAlgContextSvc* svc = ... ;

// get the appropriate algorithm:
IAlgorithm* alg = getAlgorithm ( svc , selector ) ;

See also

IAlgContextSvc

Gaudi::Utils::AlgSelector

Parameters

svc	pointer to Algororithm Contetx Service
sel	the selection functor

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 26 of file GetAlg.cpp.

{
  return svc ? getAlgorithm ( svc->algorithms() , sel ) : nullptr;
}

GAUDI_API IAlgorithm * Gaudi::Utils::getAlgorithm	(	const std::vector< IAlgorithm * > &	lst,
		const AlgSelector &	sel
	)

simple function to get the algorithm from Context Service

// get the selector
const AlgSelector& selector = ... ;

// get the list of algorithms:
const std::vector<IAlgorithm*>& algs = ... ;

// get the appropriate algorithm:
IAlgorithm* alg = getAlgorithm ( algs  , selector ) ;

See also

IAlgContextSvc

Gaudi::Utils::AlgSelector

Parameters

lst	list of the algorithms
sel	the selection functor

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 36 of file GetAlg.cpp.

{
  auto it = std::find_if( lst.rbegin(), lst.rend(), std::cref(sel));
  return it != lst.rend() ? *it : nullptr ;
}

template<class TYPE >

_GetType< TYPE >::return_type Gaudi::Utils::getFromTS ( IDataProviderSvc *  service, const std::string &  location  )

inline

Helper function to provide the minimal lookup and cast functionality of SmartDataPtr used in the helper classes.

Definition at line 61 of file GetData.h.

                                                                               {
      DataObject *obj = nullptr;
      // Return the casted pointer if the retrieve was successful or nullptr otherwise.
      return service->retrieveObject(location, obj).isSuccess() ?
             dynamic_cast<typename _GetType<TYPE>::return_type>(obj) :
             nullptr;
    }

GAUDI_API GaudiAlgorithm * Gaudi::Utils::getGaudiAlg

(

const IAlgContextSvc *

svc

)

simple function to extract the last active GaudiAlgorithm from the context

// get the context service:
const IAlgContextSvc* svc = ... ;

GaudiAlgorithm* ga = getGaudiAlg ( svc ) ;

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 63 of file GetAlgs.cpp.

{ return getAlg<GaudiAlgorithm> ( svc ) ; }

GAUDI_API GaudiSequencer * Gaudi::Utils::getGaudiSequencer

(

const IAlgContextSvc *

svc

)

simple function to extract the last active GaudiSequencer from the context

// get the context service:
const IAlgContextSvc* svc = ... ;

GaudiSequencer* sa = getGaudiSequencer ( svc ) ;

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 123 of file GetAlgs.cpp.

{ return getAlg<GaudiSequencer> ( svc ) ; }

GAUDI_API GaudiHistoAlg * Gaudi::Utils::getHistoAlg

(

const IAlgContextSvc *

svc

)

simple function to extract the last active GaudiHistoAlg from the context

// get the context service:
const IAlgContextSvc* svc = ... ;

GaudiHistoAlg* ha = getHistoAlg ( svc ) ;

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 83 of file GetAlgs.cpp.

{ return getAlg<GaudiHistoAlg> ( svc ) ; }

GAUDI_API Property * Gaudi::Utils::getProperty	(	const IProperty *	p,
		const std::string &	name
	)

simple function which gets the property with given name from the component

const IProperty* p = ... ;

const Property* pro = getProperty( p , "Context" ) ;

Parameters

p	pointer to IProperty object
name	property name (case insensitive)

Returns

property with the given name (if exists), NULL otherwise

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 278 of file Property.cpp.

{
  // trivial check
  if ( !p      ) { return nullptr ; }                          // RETURN
  // get all properties
  const auto& props = p->getProperties() ;
  // comparison criteria:
  auto ifound = std::find_if ( props.begin(), props.end(), is_iByName{ name } );
  return ifound != props.end() ? *ifound : nullptr;
}

GAUDI_API Property * Gaudi::Utils::getProperty	(	const IInterface *	p,
		const std::string &	name
	)

simple function which gets the property with given name from the component

const IInterface* p = ... ;

const Property* pro = getProperty( p , "Context" ) ;

Parameters

p	pointer to IInterface object
name	property name (case insensitive)

Returns

property with the given name (if exists), NULL otherwise

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 309 of file Property.cpp.

{
  // trivial check
  if ( !p        ) { return nullptr ; }                                // RETURN
  // remove const-qualifier
  IInterface* _i = const_cast<IInterface*>( p ) ;
  if ( !_i        ) { return nullptr ; }                                // RETURN
  SmartIF<IProperty> property( _i ) ;
  return property ? getProperty ( property , name ) : nullptr;
}

GAUDI_API const Property * Gaudi::Utils::getProperty	(	const std::vector< const Property * > *	p,
		const std::string &	name
	)

get the property by name from the list of the properties

 IJobOptionsSvc* svc = ... ;

 const std::string client = ... ;

// get the property:
const Property* context =
    getProperty ( svc->getProperties( client ) , "Context" )

See also

IJobOptionsSvc

Parameters

p	list of properties
name	property name (case insensitive)

Returns

property with the given name (if exists), NULL otherwise

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 375 of file Property.cpp.

{
  // trivial check
  if ( !p             ) { return nullptr ; }                 // RETURN
  auto ifound = std::find_if ( p->begin() , p->end() , is_iByName{ name } ) ;
  return p->end() != ifound ? *ifound : nullptr ; // RETURN
}

GAUDI_API IAlgorithm * Gaudi::Utils::getSequencer

(

const IAlgContextSvc *

svc

)

simple function to extract the last active "Sequencer" () GaudiSequencer or simple Sequencer) from the context

// get the context service:
const IAlgContextSvc* svc = ... ;

IAlgorithm* a = getSequencer ( svc ) ;

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 163 of file GetAlgs.cpp.

{
  if ( !svc            ) { return nullptr ; }  // RETURN
  //
  AlgTypeSelector<GaudiSequencer> sel1 ;
  AlgTypeSelector<Sequencer>      sel2 ;
 
  const auto& algs = svc->algorithms();
  auto a = std::find_if( algs.rbegin(), algs.rend(), 
                         [&](IAlgorithm* alg) { return sel1(alg) || sel2(alg); } );
  return a!=algs.rend() ?  *a  : nullptr;
}

GAUDI_API Sequencer * Gaudi::Utils::getSequencerAlg

(

const IAlgContextSvc *

svc

)

simple function to extract the last active Sequencer from the context

// get the context service:
const IAlgContextSvc* svc = ... ;

Sequencer* sa = getSequencerAlg ( svc ) ;

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 142 of file GetAlgs.cpp.

{ return getAlg<Sequencer> ( svc ) ; }

GAUDI_API GaudiTupleAlg * Gaudi::Utils::getTupleAlg

(

const IAlgContextSvc *

svc

)

simple function to extract the last active GaudiTupleAlg from the context

// get the context service:
const IAlgContextSvc* svc = ... ;

GaudiTupleAlg* ta = getTupleAlg ( svc ) ;

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-09-07

Definition at line 103 of file GetAlgs.cpp.

{ return getAlg<GaudiTupleAlg> ( svc ) ; }

GAUDI_API bool Gaudi::Utils::hasProperty	(	const IProperty *	p,
		const std::string &	name
	)

simple function which check the existence of the property with the given name.

const IProperty* p = ... ;

const bool = hasProperty( p , "Context" ) ;

Parameters

p	pointer to IProperty object
name	property name (case insensitive)

Returns

true if "p" has a property with such name

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 159 of file Property.cpp.

{
  // delegate the actual work to another method ;
  return p && getProperty ( p , name ) ;
}

GAUDI_API bool Gaudi::Utils::hasProperty	(	const IInterface *	p,
		const std::string &	name
	)

simple function which check the existence of the property with the given name.

IInterface* p = .

const bool = hasProperty( p , "Context" ) ;

Parameters

p	pointer to IInterface object (any component)
name	property name (case insensitive)

Returns

true if "p" has a property with such name

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 133 of file Property.cpp.

{
  // delegate to another method after trivial check
  return p && getProperty ( p , name ) ;
}

GAUDI_API bool Gaudi::Utils::hasProperty	(	const std::vector< const Property * > *	p,
		const std::string &	name
	)

check the property by name from the list of the properties

 IJobOptionsSvc* svc = ... ;

 const std::string client = ... ;

// get the property:
bool context =
    hasProperty ( svc->getProperties( client ) , "Context" )

See also

IJobOptionsSvc

Parameters

p	list of properties
name	property name (case insensitive)

Returns

true if the property exists

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 344 of file Property.cpp.

{
  // delegate to another method
  return getProperty ( p , name ) ;
}

std::ostream & Gaudi::Utils::operator<< ( std::ostream &  s, const TypeNameString &  tn  )

inline

Output stream operator for TypeNameString instances.

Definition at line 28 of file TypeNameString.h.

                                                                            {
      return s << tn.type() << '/' << tn.name();
    }

template<class TYPE >

StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const TYPE &	value,
		const std::string &	doc
	)

simple function to set the property of the given object from the value

IProperty* component = ... ;

std::vector<double> data = ... ;
StatusCode sc = setProperty ( componet , "Data" ,  data ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

IProperty* component = ... ;

std::vector<double> data = ... ;
StatusCode sc = setProperty ( component , "Data" ,  data ) ;

std::map<std::string,double> cuts = ... ;
sc = setProperty ( component , "Cuts" , cuts ) ;

std::map<std::string,std::string> dict = ... ;
sc = setProperty ( component , "Dictionary" , dict ) ;

Note: the native interface IProperty allows setting of the properties either directly from other properties or from strings only

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 1187 of file Property.h.

    {
      return component && hasProperty(component,name) ?
                Gaudi::Utils::setProperty ( component , name , 
                                            Gaudi::Utils::toString ( value ) , doc ) :
                StatusCode::FAILURE;
    }

template<class TYPE >

StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const TYPE &	value
	)

simple function to set the property of the given object from the value

IProperty* component = ... ;

std::vector<double> data = ... ;
StatusCode sc = setProperty ( componet , "Data" ,  data ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 1087 of file Property.h.

    { return setProperty ( component , name , value , std::string() ) ; }

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const std::string &	value,
		const std::string &	doc = ""
	)

the full specialization of the previous method setProperty( IProperty, std::string, const TYPE&) for standard strings

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 421 of file Property.cpp.

{
  if ( !component ) { return StatusCode::FAILURE ; }   // RETURN
  if ( !hasProperty ( component , name ) ) { return StatusCode::FAILURE ; }
  StatusCode sc = component -> setProperty ( name , value ) ;
  if ( !doc.empty() )
  {
    Property* p = getProperty( component , name ) ;
    if ( p ) { p -> setDocumentation ( doc ) ; }
  }
  sc.ignore() ;
  return sc ;
}

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const char *	value,
		const std::string &	doc = ""
	)

the full specialization of the method setProperty( IProperty, std::string, const TYPE&) for C-strings

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 399 of file Property.cpp.

{
  return Gaudi::Utils::setProperty ( component , name , std::string{value} , doc ) ;
}

template<unsigned N>

StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const char(&)	value[N],
		const std::string &	doc = ""
	)

the full specialization of the method setProperty( IProperty, std::string, const TYPE&) for C-arrays

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 1145 of file Property.h.

    {
      return component ? setProperty ( component , name , 
                                       std::string ( value , value + N ), doc )
                       : StatusCode::FAILURE;
    }

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const Property *	property,
		const std::string &	doc = ""
	)

simple function to set the property of the given object from another property

IProperty* component = ... ;

const Property* prop = ... ;
StatusCode sc = setProperty ( component , "Data" ,  prop  ) ;

Parameters

component	component which needs to be configured
name	name of the property
property	the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 461 of file Property.cpp.

{
  if ( !component || !property ) return StatusCode::FAILURE ;
  Property* p = getProperty ( component , name ) ;
  if ( !p || !p->assign ( *property ) ) return StatusCode::FAILURE ;
  if ( !doc.empty()  ) { p->setDocumentation( doc ) ; }
  return StatusCode::SUCCESS ;
}

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const Property &	property,
		const std::string &	doc = ""
	)

simple function to set the property of the given object from another property

IProperty* component = ... ;

const Property& prop = ... ;
StatusCode sc = setProperty ( component , "Data" ,  prop  ) ;

Parameters

component	component which needs to be configured
name	name of the property
property	the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 496 of file Property.cpp.

{ return setProperty ( component , name , &property , doc ) ; }

template<class TYPE >

StatusCode Gaudi::Utils::setProperty	(	IProperty *	component,
		const std::string &	name,
		const SimpleProperty< TYPE > &	value,
		const std::string &	doc = ""
	)

simple function to set the property of the given object from another property

IProperty* component = ... ;

SimpleProperty<std::vector<int> > m_data = ... ;

StatusCode sc = setProperty ( component , "Data" ,  prop  ) ;

Parameters

component	component which needs to be configured
name	name of the property
value	the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 1276 of file Property.h.

    {
      return setProperty ( component , name , &value , doc ) ;
    }

template<class TYPE >

StatusCode Gaudi::Utils::setProperty	(	IInterface *	component,
		const std::string &	name,
		const TYPE &	value,
		const std::string &	doc = ""
	)

simple function to set the property of the given object from the value

IInterface* component = ... ;

std::vector<double> data = ... ;
StatusCode sc = setProperty ( component , "Data" ,  data ) ;

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 1306 of file Property.h.

    {
      if ( !component ) { return StatusCode::FAILURE ; }
      auto property = SmartIF<IProperty>{  component } ;
      return property ? setProperty ( property , name , value , doc ) 
                      : StatusCode::FAILURE;
    }

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IInterface *	component,
		const std::string &	name,
		const std::string &	value,
		const std::string &	doc = ""
	)

the full specialization of the method setProperty( IInterface , std::string, const TYPE&) for standard strings

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 516 of file Property.cpp.

{
  if ( !component ) { return StatusCode::FAILURE ; }
  SmartIF<IProperty> property ( component ) ;
  return property ? setProperty ( property , name , value , doc ) 
                  : StatusCode::FAILURE ; 
}

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IInterface *	component,
		const std::string &	name,
		const char *	value,
		const std::string &	doc = ""
	)

the full specialization of the method setProperty( IInterface , std::string, const TYPE&) for C-strings

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 541 of file Property.cpp.

{
  return setProperty ( component , name , std::string{ value } , doc ) ;
}

template<unsigned N>

StatusCode Gaudi::Utils::setProperty	(	IInterface *	component,
		const std::string &	name,
		const char(&)	value[N],
		const std::string &	doc = ""
	)

the full specialization of the method setProperty( IInterface, std::string, const TYPE&) for C-arrays

Parameters

component	component which needs to be configured
name	name of the property
value	value of the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 1368 of file Property.h.

    {
      if ( 0 == component ) { return StatusCode::FAILURE ; }
      return setProperty ( component , name , 
                           std::string{ value , value + N }, doc ) ;
    }

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IInterface *	component,
		const std::string &	name,
		const Property *	property,
		const std::string &	doc = ""
	)

simple function to set the property of the given object from another property

IInterface* component = ... ;

const Property* prop = ... ;
StatusCode sc = setProperty ( component , "Data" ,  prop  ) ;

Parameters

component	component which needs to be configured
name	name of the property
property	the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 572 of file Property.cpp.

{
  if ( !component ) { return StatusCode::FAILURE ; }
  SmartIF<IProperty> prop  ( component ) ;
  if ( !prop          ) { return StatusCode::FAILURE ; }
  return setProperty ( prop  , name , property , doc ) ;
}

GAUDI_API StatusCode Gaudi::Utils::setProperty	(	IInterface *	component,
		const std::string &	name,
		const Property &	property,
		const std::string &	doc = ""
	)

simple function to set the property of the given object from another property

IInterface* component = ... ;

const Property& prop = ... ;
StatusCode sc = setProperty ( component , "Data" ,  prop  ) ;

Parameters

component	component which needs to be configured
name	name of the property
property	the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 606 of file Property.cpp.

{ return setProperty ( component , name , &property , doc ) ; }

template<class TYPE >

StatusCode Gaudi::Utils::setProperty	(	IInterface *	component,
		const std::string &	name,
		const SimpleProperty< TYPE > &	value,
		const std::string &	doc = ""
	)

simple function to set the property of the given object from another property

IInterface* component = ... ;

SimpleProperty<std::vector<int> > m_data = ... ;

StatusCode sc = setProperty ( component , "Data" ,  prop  ) ;

Parameters

component	component which needs to be configured
name	name of the property
value	the property
doc	the new documentation string

See also

IProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 1457 of file Property.h.

    {
      return setProperty ( component , name , &value , doc ) ;
    }

template<class ITERATOR >

std::ostream & Gaudi::Utils::toStream ( ITERATOR  first, ITERATOR  last, std::ostream &  s, const std::string &  open, const std::string &  close, const std::string &  delim  )

inline

the helper function to print the sequence

Parameters

first	(INPUT) begin-iterator for the sequence
last	(INPUT) end-iterator for the sequence
s	(UPDATE) the stream itself
open	(INPUT) "open"-symbol
close	(INPUT) "close"-symbol
delim	(INPUT) "delimiter"-symbol

Returns

the stream

Author

Vanya BELYAEV Ivan..nosp@m.BEly.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-15

Definition at line 319 of file ToStream.h.

    {
      using ref_t = typename std::iterator_traits<ITERATOR>::reference;
      using GaudiUtils::detail::ostream_joiner;
      return ostream_joiner( s << open, first, last, delim,
                             [](std::ostream& os, ref_t i ) -> std::ostream&
                             { return toStream( i, os ); } ) << close;
    }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const TH1D &	histo,
		std::ostream &	stream,
		const bool	asXML = false
	)

stream the ROOT histogram into output stream

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream
asXML	(INPUT) use XML-format

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 184 of file Histo2String.cpp.

                         { return _toStream_1D_ ( histo , stream , asXML ) ; }

template<class TYPE >

std::ostream & Gaudi::Utils::toStream ( const TYPE &  obj, std::ostream &  s  )

inline

the generic implementation of the printout to the std::ostream

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 303 of file ToStream.h.

    { return s << obj ; }

template<class TYPE , std::size_t N>

std::ostream & Gaudi::Utils::toStream ( const std::array< TYPE, N > &  obj, std::ostream &  s  )

inline

printout of class std::array The format is "Python's tuple"

Parameters

obj	(INPUT) the arary to be printed
s	(UPDATE) the actual stream

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-16

Definition at line 50 of file StdArrayAsProperty.h.

    {
      return toStream
        ( obj.begin () , obj.end   () , s , " ( "  , " )"   , " , "  ) ;
    }

template<class TYPE , std::size_t N>

std::ostream & Gaudi::Utils::toStream ( const boost::array< TYPE, N > &  obj, std::ostream &  s  )

inline

printout of class boost::array The format is "Python's tuple"

Parameters

obj	(INPUT) the arary to be printed
s	(UPDATE) the actual stream

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-16

Definition at line 51 of file BoostArrayAsProperty.h.

    {
      return toStream 
        ( obj.begin () , obj.end   () , s , "( "  , " )"   , " , "  ) ;
    }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const TH2D &	histo,
		std::ostream &	stream,
		const bool	asXML = false
	)

stream the ROOT histogram into output stream

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream
asXML	(INPUT) use XML-format

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 206 of file Histo2String.cpp.

                         { return _toStream_2D_ ( histo , stream , asXML ) ; }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const TH1F &	histo,
		std::ostream &	stream,
		const bool	asXML = false
	)

stream the ROOT histogram into output stream

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream
asXML	(INPUT) use XML-format

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 195 of file Histo2String.cpp.

                         { return _toStream_1D_ ( histo , stream , asXML ) ; }

std::ostream & Gaudi::Utils::toStream ( const std::string &  obj, std::ostream &  s  )

inline

the printtout of the strings.

the string is printed a'la Python using the quotes

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 77 of file ToStream.h.

    {
      auto c = ( std::string::npos == obj.find('\'') ? '\'' : '\"' );
      return s << c << obj << c;
    }

template<class SCALAR >

std::ostream & Gaudi::Utils::toStream	(	const SCALAR &	,
		std::ostream &
	)

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const DataHandle &	v,
		std::ostream &	o
	)

Definition at line 32 of file DataHandle.cpp.

    {
      o << "'" << v.objKey() << "'";
      return o;
    }

template<class SCALAR , unsigned int N>

std::ostream & Gaudi::Utils::toStream	(	const ROOT::Math::SVector< SCALAR, N > &	obj,
		std::ostream &	s
	)

the general streaming function for SVector using python-tupel format

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-10-07

Definition at line 85 of file SVectorAsProperty.h.

    {
      s << "( ";
      for ( auto cur = obj.begin() ; obj.end() != cur ; ++cur )
      {
        if ( obj.begin() != cur ) { s << " , "; }
        toStream ( *cur , s ) ;
      }
      return s << " )";
    }

std::ostream & Gaudi::Utils::toStream ( const bool  obj, std::ostream &  s  )

inline

the printout of boolean values "a'la Python"

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 87 of file ToStream.h.

    { return s << ( obj ? "True" : "False" ) ; }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const TH2F &	histo,
		std::ostream &	stream,
		const bool	asXML = false
	)

stream the ROOT histogram into output stream

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream
asXML	(INPUT) use XML-format

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 217 of file Histo2String.cpp.

                         { return _toStream_2D_ ( histo , stream , asXML ) ; }

std::ostream & Gaudi::Utils::toStream ( const float  obj, std::ostream &  s, const int  prec = 6  )

inline

the printout of float values with the reasonable precision

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 94 of file ToStream.h.

    {
      const int  p = s.precision() ;
      return s << std::setprecision (  prec ) << obj << std::setprecision ( p ) ;
    }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const AIDA::IHistogram1D &	histo,
		std::ostream &	stream,
		const bool	asXML = false
	)

stream the AIDA histogram into output stream

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream
asXML	(INPUT) use XML-format

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 228 of file Histo2String.cpp.

{
  auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &histo ) ;
  return root ? toStream  ( *root , stream , asXML ) : stream ;
}

std::ostream & Gaudi::Utils::toStream ( const double  obj, std::ostream &  s, const int  prec = 8  )

inline

the printout of double values with the reasonable precision

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 104 of file ToStream.h.

    {
      const int p = s.precision() ;
      return s << std::setprecision ( prec ) << obj << std::setprecision ( p ) ;
    }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const AIDA::IHistogram2D &	histo,
		std::ostream &	stream,
		const bool	asXML = false
	)

stream the AIDA histogram into output stream

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream
asXML	(INPUT) use XML-format

Returns

the updated stream

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 243 of file Histo2String.cpp.

{
  //
  auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &histo ) ;
  return root ? toStream  ( *root , stream , asXML ) : stream;
}

std::ostream & Gaudi::Utils::toStream ( const long double  obj, std::ostream &  s, const int  prec = 10  )

inline

the printout of long double values with the reasonable precision

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-09-09

Definition at line 114 of file ToStream.h.

    {
      const int p = s.precision() ;
      return s << std::setprecision ( prec ) << obj << std::setprecision ( p ) ;
    }

template<class KTYPE , class VTYPE >

std::ostream & Gaudi::Utils::toStream ( const std::pair< KTYPE, VTYPE > &  obj, std::ostream &  s  )

inline

the partial template specialization of std::pair<KTYPE,VTYPE> printout the pair is printed a'la Python tuple: " ( a , b )"

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 129 of file ToStream.h.

    {
      return toStream( obj.second,
                       toStream( obj.first, s << "( " ) << " , "  )
              << " )" ;
    }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const DataObjID &	v,
		std::ostream &	o
	)

Definition at line 145 of file DataObjIDProperty.cpp.

                                                {
      if (v.clid() == 0) {
    o << "'" << v.key() << "'";
      } else {
    o << "(" << v.clid() << ",'" << v.key() << "')";
      }
      return o;
    }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const DataObjIDColl &	v,
		std::ostream &	o
	)

Definition at line 155 of file DataObjIDProperty.cpp.

                                                    {
      o << "[";
      for (auto &i : v) {
    toStream(i,o);
    o << ",";
      }
      o << "]";
      return o;
    }

template<class TYPE , class ALLOCATOR >

std::ostream & Gaudi::Utils::toStream ( const std::vector< TYPE, ALLOCATOR > &  obj, std::ostream &  s  )

inline

the partial template specialization of std::vector<TYPE,ALLOCATOR> printout.

The vector is printed a'la Python list: "[ a, b, c ]"

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 144 of file ToStream.h.

    {
      return toStream ( obj.begin() , obj.end () , s , "[ " , " ]" , " , " ) ;
    }

template<class TYPE , class ALLOCATOR >

std::ostream & Gaudi::Utils::toStream ( const std::list< TYPE, ALLOCATOR > &  obj, std::ostream &  s  )

inline

the partial template specialization of std::list<TYPE,ALLOCATOR> printout.

The vector is printed a'la Python list: "[ a, b, c ]"

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-04-08

Definition at line 157 of file ToStream.h.

    {
      return toStream ( obj.begin() , obj.end () , s , "[ " , " ]" , " , " ) ;
    }

template<class TYPE , class CMP , class ALLOCATOR >

std::ostream & Gaudi::Utils::toStream ( const std::set< TYPE, CMP, ALLOCATOR > &  obj, std::ostream &  s  )

inline

the partial template specialization of std::set<TYPE,CMP,ALLOCATOR> printout.

The vector is printed a'la Python list: "[ a, b, c ]"

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 170 of file ToStream.h.

    {
      return toStream ( obj.begin() , obj.end () , s , "[ " , " ]" , " , " ) ;
    }

template<class KTYPE , class VTYPE , class CMP , class ALLOCATOR >

std::ostream & Gaudi::Utils::toStream ( const std::map< KTYPE, VTYPE, CMP, ALLOCATOR > &  obj, std::ostream &  s  )

inline

the partial template specialization of std::map<KTYPE,VTYPE,CMP,ALLOCATOR> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )"

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 184 of file ToStream.h.

    {
      using GaudiUtils::detail::ostream_joiner;
      return ostream_joiner( s << "{ ", obj, " , ",
                             [](std::ostream& os, const std::pair<const KTYPE,VTYPE>& i)
                             -> std::ostream&
                             { return toStream( i.second, toStream( i.first, os ) << " : " ); }
             ) << " }";
    }

template<class KTYPE , class VTYPE , class CMP , class ALLOCATOR >

std::ostream & Gaudi::Utils::toStream ( const GaudiUtils::VectorMap< KTYPE, VTYPE, CMP, ALLOCATOR > &  obj, std::ostream &  s  )

inline

the partial template specialization of GaudiUtils::VectorMap<KTYPE,VTYPE,CMP,ALLOCATOR> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )"

See also

GaudiUtils::VectorMap

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 204 of file ToStream.h.

    {
      using GaudiUtils::detail::ostream_joiner;
      return ostream_joiner( s << "{ ", obj, " , ",
                               [](std::ostream& os, const std::pair<const KTYPE,VTYPE>& i )
                               -> std::ostream&
                               { return toStream( i.second, toStream( i.first, os ) << " : " ); }
             ) << " }";
    }

template<class KTYPE , class VTYPE , class MAP >

std::ostream & Gaudi::Utils::toStream ( const GaudiUtils::Map< KTYPE, VTYPE, MAP > &  obj, std::ostream &  s  )

inline

the partial template specialization of GaudiUtils::Map<KTYPE,VTYPE,MAP> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )"

See also

GaudiUtils::VectorMap

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 224 of file ToStream.h.

    {
      using GaudiUtils::detail::ostream_joiner;
      return ostream_joiner( s << "{ ", obj,  " , " ,
                             [](std::ostream& s, const std::pair<const KTYPE,VTYPE>& i )
                             -> std::ostream&
                             { return toStream( i.second, toStream( i.first, s ) << " : " ) ; }
             ) << " }";
    }

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const Gaudi::XYZPoint &	obj,
		std::ostream &	s
	)

print XYZ point

Definition at line 130 of file ParsersVct.cpp.

{
  s << "( "  ;
  toStream ( obj.X () , s ) ;
  s << " , " ;
  toStream ( obj.Y () , s ) ;
  s << " , " ;
  toStream ( obj.Z () , s ) ;
  s << " )"  ;
  return s ;
}

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const Gaudi::XYZVector &	obj,
		std::ostream &	s
	)

print XYZ vector

Definition at line 145 of file ParsersVct.cpp.

{
  s << "( "  ;
  toStream ( obj.X () , s ) ;
  s << " , " ;
  toStream ( obj.Y () , s ) ;
  s << " , " ;
  toStream ( obj.Z () , s ) ;
  s << " )"  ;

  return s ;
}

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const Gaudi::LorentzVector &	obj,
		std::ostream &	s
	)

print Lorentz vector

Definition at line 161 of file ParsersVct.cpp.

{

  s << "( " ;
  toStream ( obj.Px () , s , 12 ) ;
  s << " , " ;
  toStream ( obj.Py () , s , 12 ) ;
  s << " , " ;
  toStream ( obj.Pz () , s , 13 ) ;
  s << " , "  ;
  toStream ( obj.E  () , s , 14 ) ;
  s << " )"  ;

  return s ;
}

GAUDI_API std::ostream & Gaudi::Utils::toStream	(	const Gaudi::StringKey &	key,
		std::ostream &	s
	)

send the object to stream (needed to use it as property)

See also

Gaudi::StringKey

Gaudi::Utils::toString

Gaudi::Utils::toStream

Parameters

key	(INPUT) the object to be printed
s	(OUTPUT) the stream

Returns

the stream

Author

Vanya BELYAEV Iavn..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-10-07

Definition at line 69 of file StringKey.cpp.

{ return Gaudi::Utils::toStream ( key.str() , s ) ; }

template<class KTYPE , class VTYPE , class HASH , class MAP >

std::ostream & Gaudi::Utils::toStream ( const GaudiUtils::HashMap< KTYPE, VTYPE, HASH, MAP > &  obj, std::ostream &  s  )

inline

the partial template specialization of GaudiUtils::HashMap<KTYPE,VTYPE,HASH,MAP> printout the map is printed a'la Python dict: " ( a : b , c: d , e : f )"

See also

GaudiUtils::VectorMap

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

Definition at line 244 of file ToStream.h.

    {
        using GaudiUtils::detail::ostream_joiner;
        return ostream_joiner( s << "{ ", obj,  " , ",
                               [](std::ostream& os, const std::pair<const KTYPE,VTYPE>& p)
                               -> std::ostream&
                               { return toStream( p.second, toStream( p.first, os) << " : " ); }
               ) << " }";
    }

template<class TYPE , unsigned int N>

std::ostream & Gaudi::Utils::toStream	(	TYPE(&)	obj[N],
		std::ostream &	s
	)

the specialization for C-arrays, a'la python tuple

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-10-05

Definition at line 259 of file ToStream.h.

    {
      return toStream ( obj , obj + N , s , "( " , " )" , " , " ) ;
    }

template<class TYPE , unsigned int N>

std::ostream & Gaudi::Utils::toStream	(	const TYPE(&)	obj[N],
		std::ostream &	s
	)

the specialization for C-arrays, a'la python tuple

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-10-05

Definition at line 269 of file ToStream.h.

    {
      return toStream ( obj , obj + N , s , "( " , " )" , " , " ) ;
    }

template<unsigned int N>

std::ostream & Gaudi::Utils::toStream	(	char(&)	obj[N],
		std::ostream &	s
	)

the specialization for C-string, a'la python tuple

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-10-05

Definition at line 279 of file ToStream.h.

    { return toStream ( std::string ( obj , obj+N ) , s ) ; }

template<unsigned int N>

std::ostream & Gaudi::Utils::toStream	(	const char(&)	obj[N],
		std::ostream &	s
	)

the specialization for C-string, a'la python tuple

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-10-05

Definition at line 287 of file ToStream.h.

    { return toStream ( std::string ( obj , obj+N ) , s ) ; }

std::ostream & Gaudi::Utils::toStream ( const char *  obj, std::ostream &  s  )

inline

the specialization for C-string, a'la python tuple

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-10-05

Definition at line 294 of file ToStream.h.

    { return toStream ( std::string ( obj ) , s ) ; }

template<typename... Args>

std::ostream & Gaudi::Utils::toStream ( const std::tuple< Args...> &  tuple, std::ostream &  s  )

inline

the helper function to print the tuple

Parameters

tulpe

(INPUT) tuple

Returns

the stream

Author

Aleander Mazurov alexa.nosp@m.nder.nosp@m..mazu.nosp@m.rov@.nosp@m.cern..nosp@m.ch

Date

2015-03-21

Definition at line 358 of file ToStream.h.

                                                                                {
        return TuplePrinter<decltype(tuple), sizeof...(Args)>::toStream(tuple, s << " ( ")<< " ) ";
     }

GAUDI_API std::string Gaudi::Utils::toString	(	const TH1D &	histo,
		const bool	asXML = false
	)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 261 of file Histo2String.cpp.

{
  std::ostringstream o ;
  toStream ( histo , o , asXML ) ;
  return o.str() ;
}

GAUDI_API std::string Gaudi::Utils::toString	(	const TH2D &	histo,
		const bool	asXML = false
	)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 295 of file Histo2String.cpp.

{
  std::ostringstream o ;
  toStream ( histo , o , asXML ) ;
  return o.str() ;
}

GAUDI_API std::string Gaudi::Utils::toString	(	const TH1F &	histo,
		const bool	asXML = false
	)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 278 of file Histo2String.cpp.

{
  std::ostringstream o ;
  toStream ( histo , o , asXML ) ;
  return o.str() ;
}

GAUDI_API std::string Gaudi::Utils::toString	(	const TH2F &	histo,
		const bool	asXML = false
	)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 312 of file Histo2String.cpp.

{
  std::ostringstream o ;
  toStream ( histo , o , asXML ) ;
  return o.str() ;
}

GAUDI_API std::string Gaudi::Utils::toString	(	const AIDA::IHistogram1D &	histo,
		const bool	asXML = false
	)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 329 of file Histo2String.cpp.

{
  std::ostringstream o ;
  toStream ( histo , o , asXML ) ;
  return o.str() ;
}

GAUDI_API std::string Gaudi::Utils::toString	(	const AIDA::IHistogram2D &	histo,
		const bool	asXML = false
	)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 346 of file Histo2String.cpp.

{
  std::ostringstream o ;
  toStream ( histo , o , asXML ) ;
  return o.str() ;
}

GAUDI_API std::string Gaudi::Utils::toString

(

const AIDA::IHistogram1D *

histo

)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 362 of file Histo2String.cpp.

{
  return histo ? toString ( *histo ) : "{}";
}

GAUDI_API std::string Gaudi::Utils::toString

(

AIDA::IHistogram1D *

histo

)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 375 of file Histo2String.cpp.

{
  return histo ? toString ( *histo ) : "{}";
}

GAUDI_API std::string Gaudi::Utils::toString

(

const TH1D *

histo

)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 388 of file Histo2String.cpp.

{
  return histo ? toString ( *histo ) : "{}";
}

GAUDI_API std::string Gaudi::Utils::toString

(

TH1D *

histo

)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 414 of file Histo2String.cpp.

{
  return histo ? toString ( *histo ) : "{}";
}

GAUDI_API std::string Gaudi::Utils::toString

(

const TH2D *

histo

)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 401 of file Histo2String.cpp.

{
  return histo ? toString ( *histo ) : "{}";
}

GAUDI_API std::string Gaudi::Utils::toString

(

TH2D *

histo

)

convert the histogram into the string

Parameters

histo	(INPUT) the histogram to be streamed
asXML	(INPUT) use XML-format

Returns

the string representation of the histogram

Author

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date

2009-09-26

Definition at line 427 of file Histo2String.cpp.

{
  return histo ? toString ( *histo ) : "{}";
}

template<class TYPE >

std::string Gaudi::Utils::toString ( const TYPE &  obj )

inline

the generic implementation of the type conversion to the string

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

See also

Gaudi::Utils::toStream

Todo:

need to be compared with boost::lexical_cast

Author

Alexander MAZUROV Alexa.nosp@m.nder.nosp@m..Mazu.nosp@m.rov@.nosp@m.gmail.nosp@m..com

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2006-05-12

See also

Gaudi::Utils::toStream

Todo:

need to be compared with boost::lexical_cast

Definition at line 371 of file ToStream.h.

    {
      std::ostringstream s;
      std::ios::fmtflags orig_flags = s.flags();
      s.setf(std::ios::showpoint); // to display correctly floats
      toStream ( obj , s);
      s.flags(orig_flags);
      return s.str();
    }