cms Namespace Reference

Namespaces
namespace	detail
Classes
class	AlCaDiJetsProducer
class	Analyzer_minbias
class	BHFilter
class	CATopJetProducer
class	CkfDebugTrackCandidateMaker
class	CkfTrackCandidateMaker
class	CkfTrackCandidateMakerBase
class	CkfTrajectoryMaker
class	ClusterizerFP420
class	ClusterMTCCFilter
class	CompareTrajChi
class	CompareTrajLay
class	CompoundJetProducer
class	CosmicTIFTrigFilter
class	CosmicTrackFinder
class	CRC32Calculator
class	Digest
class	DigitizerFP420
class	DiJetAnalyzer
class	Exception
class	FastSimDataFilter
class	GammaJetAnalysis
class	HcalConstantsASCIIWriter
class	HitReCalibrator
class	JetCorrectionProducer
class	JetVertexAssociation
struct	MD5Result
class	METProducer
class	MinBias
class	MTCCHLTrigger
class	MuonMET
class	MuonMETValueMapProducer
class	MuonTCMETValueMapProducer
class	ProducerAnalyzer
class	ReconstructerFP420
class	SimpleTrackListMerger
class	SiPixelClusterProducer
class	SiPixelDigitizer
class	SiPixelRecHitConverter
class	SubEventGenJetProducer
class	SubJetProducer
class	TECClusterFilter
class	TrackerizerFP420
class	TrackListMerger
class	TrackMTCCFilter
Functions
void	Adler32 (char const *data, size_t len, uint32_t &a, uint32_t &b)
uint32_t	Adler32 (char const *data, size_t len)
edm::ProductID	clusterProduct (const TrackingRecHit *hit)
edm::ProductID	clusterProductB (const TrackingRecHit *hit)
def	cms_error
def	config
def	generate
bool	operator!= (MD5Result const &a, MD5Result const &b)
bool	operator< (MD5Result const &a, MD5Result const &b)
template<typename E , typename T >
detail::Desired< E, detail::is_derived_or_same < Exception, E >::value > ::type const &	operator<< (E const &e, T const &stuff)
std::ostream &	operator<< (std::ostream &ost, Exception const &e)
template<typename E >
detail::Desired< E, detail::is_derived_or_same < Exception, E >::value > ::type const &	operator<< (E const &e, std::ios_base &(*f)(std::ios_base &))
template<typename E >
detail::Desired< E, detail::is_derived_or_same < Exception, E >::value > ::type &	operator<< (E &e, std::ios_base &(*f)(std::ios_base &))
template<typename E >
detail::Desired< E, detail::is_derived_or_same < Exception, E >::value > ::type const &	operator<< (E const &e, std::ostream &(*f)(std::ostream &))
template<typename E >
detail::Desired< E, detail::is_derived_or_same < Exception, E >::value > ::type &	operator<< (E &e, std::ostream &(*f)(std::ostream &))
template<typename E , typename T >
detail::Desired< E, detail::is_derived_or_same < Exception, E >::value > ::type &	operator<< (E &e, T const &stuff)
std::ostream &	operator<< (std::ostream &os, MD5Result const &r)
bool	operator== (MD5Result const &a, MD5Result const &b)
void	set_to_default (MD5Result &val)
def	test_cms_environment
Variables
static const char *	s_hexValues = "f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff"

---

Detailed Description

How ParameterSets are nested inside ParameterSets The main feature is that they're made persistent using a ParameterSetID, and only reconstituted as needed, when the value_ptr = 0;

This a basic exception type expected to be thrown by developer-written code. We recommend that you use it directly. It can also be used as a base class if needed.

Each Exception is identified by a category string. This category is a short word or phrase (no spaces) that described the problem that was encountered.

Information can be added to the Exception using the stream insertion operator (as one uses cout). We recommend using it in the following manner:

Example: if ((rc=func()) < 0) { throw cms::Exception("DataCorrupt") << "I died with rc = " << rc << std::endl; }

Derived types are expected to fix the category, either by 1) passing a string literal to the base class constructor, or 2) ensuring the developer gives a category name.

Example: class InfiniteLoop : public Exception { InfiniteLoop(const std::string& msg) : Exception("InfiniteLoop",msg) { } };

ExceptionCollector is a utility class that can be used to make sure that each function or functor in a sequence of calls is invoked even if a previous function throws. Each function/functor must take no arguments and return a void. boost::bind can be used to convert a function taking arguments into a function taking no arguments. The exception strings are saved in a cms::Exception for optional rethrow.

Here is an example:

ExceptionCollector c("initialMessage");

c.call(boost_bind(&MyClass::myFunction, myClassPtr)); c.call(boost_bind(&MyClass::myOtherFunction, myClassPtr, myArgPtr)); c.call(boost_bind(&myFreeFunction, myArgPtr)); if (c.hasThrown()) c.rethrow();

This insures that all three functions will be called before any exception is thrown.

SiPixelClusterProducer.cc --------------------------------------------------------------- Description: see SiPixelClusterProducer.h Author: P. Maksimovic (porting from original ORCA version) History: Oct 14, 2005, initial version Get rid of the noiseVector. d.k. 28/3/06 Implementation of the DetSetVector container. V.Chiochia, May 06 SiPixelClusterCollection typedef of DetSetVector V.Chiochia, June 06 Introduce the DetSet local container (cache) for speed. d.k. 05/07

---------------------------------------------------------------

---

Function Documentation

void cms::Adler32	(	char const *	data,
		size_t	len,
		uint32_t &	a,
		uint32_t &	b
	)

Definition at line 11 of file Adler32Calculator.cc.

References a, compareJSON::const, data, and MOD_ADLER.

Referenced by Adler32(), stor::FileHandler::checkAdler32(), edm::StreamDQMDeserializer::deserializeDQMEvent(), edm::StreamerInputSource::deserializeEvent(), edm::StreamerInputSource::deserializeRegistry(), FRDEventFileWriter::doOutputEvent(), FRDEventFileWriter::doOutputEventFragment(), edm::StreamDQMSerializer::serializeDQMEvent(), edm::StreamSerializer::serializeEvent(), edm::StreamSerializer::serializeRegistry(), and OutputFile::write().

                                                                  {
   /* data: Pointer to the data to be summed; len is in bytes */
  
    #define MOD_ADLER 65521
   
    unsigned char const* ptr = static_cast<unsigned char const*>(static_cast<void const*>(data));
    while (len > 0) {
      size_t tlen = (len > 5552 ? 5552 : len);
      len -= tlen;
      do {
        a += *ptr++;
        b += a;
      } while (--tlen);
      
      a %= MOD_ADLER;
      b %= MOD_ADLER;
    }
  
    #undef MOD_ADLER
  }

uint32_t cms::Adler32	(	char const *	data,
		size_t	len
	)

Definition at line 33 of file Adler32Calculator.cc.

References a, Adler32(), and b.

                                        {
   /* data: Pointer to the data to be summed; len is in bytes */
    uint32_t a = 1, b = 0;
    Adler32(data, len, a, b);
    return (b << 16) | a;
  }

edm::ProductID cms::clusterProduct

(

const TrackingRecHit *

hit

)

Definition at line 46 of file SimpleTrackListMerger.cc.

References cond::rpcobgas::detid, Exception, TrackingRecHit::geographicalId(), edm::ProductID::id(), ProjectedSiStripRecHit2D::originalHit(), PixelSubdetector::PixelBarrel, PixelSubdetector::PixelEndcap, and DetId::subdetId().

Referenced by cms::SimpleTrackListMerger::produce().

                                                         {
    edm::ProductID pID;
    //cast it into the proper class     and find productID
    DetId detid = hit->geographicalId(); 
    uint32_t subdet = detid.subdetId();
    if ((subdet == PixelSubdetector::PixelBarrel) || (subdet == PixelSubdetector::PixelEndcap)) {
      pID=reinterpret_cast<const SiPixelRecHit *>(hit)->cluster().id();
    } else {
      const std::type_info &type = typeid(*hit);
      if (type == typeid(SiStripRecHit2D)) {
        pID=reinterpret_cast<const SiStripRecHit2D *>(hit)->cluster().id();
      } else if (type == typeid(SiStripRecHit1D)) {
        pID=reinterpret_cast<const SiStripRecHit1D *>(hit)->cluster().id();     
      } else if (type == typeid(SiStripMatchedRecHit2D)) {
        const SiStripMatchedRecHit2D *mhit = reinterpret_cast<const SiStripMatchedRecHit2D *>(hit);
        pID=mhit->monoClusterRef().id();
      } else if (type == typeid(ProjectedSiStripRecHit2D)) {
        const ProjectedSiStripRecHit2D *phit = reinterpret_cast<const ProjectedSiStripRecHit2D *>(hit);
        pID=(&phit->originalHit())->cluster().id();
      } else throw cms::Exception("Unknown RecHit Type") << "RecHit of type " << type.name() << " not supported. (use c++filt to demangle the name)";
    }
        
    return pID;}

edm::ProductID cms::clusterProductB

(

const TrackingRecHit *

hit

)

Definition at line 104 of file TrackListMerger.cc.

Referenced by cms::TrackListMerger::produce().

                                                          {
    return reinterpret_cast<const BaseTrackerRecHit *>(hit)->firstClusterRef().id();
  }

def cms::cms_error

(

)

Definition at line 51 of file cms.py.

               :
    "Standard CMS error message"
    msg  = "\nPackages must be created in a 'subsystem'."
    msg += "\nPlease set your CMSSW environment and go to $CMSSW_BASE/src"
    msg += "\nCreate or choose directory from there and then "
    msg += "\nrun the script from that directory"
    return msg

def cms::config	(		tmpl,
			pkg_help,
			tmpl_dir
	)

Definition at line 17 of file cms.py.

                                    :
    "Parse input arguments to mk-script"
    kwds  = {'author': '', 'tmpl': tmpl,
             'args': {}, 'debug': False, 'tmpl_dir': tmpl_dir}
    etags = []
    if  len(sys.argv) >= 2: # user give us arguments
        if  sys.argv[1] in ['-h', '--help', '-help']:
            print pkg_help
            sys.exit(0)
        kwds['pname'] = sys.argv[1]
        for idx in xrange(2, len(sys.argv)):
            opt = sys.argv[idx]
            if  opt == '-author':
                kwds['author'] = sys.argv[idx+1]
                continue
            if  opt.find('example') != -1:
                etags.append('@%s' % opt)
                continue
            if  opt in ['-h', '--help', '-help']:
                print pkg_help
                sys.exit(0)
            if  opt == '-debug':
                kwds['debug'] = True
                continue
    elif len(sys.argv) == 1:
        # need to walk
        msg = 'Please enter %s name: ' % tmpl.lower()
        kwds['pname'] = raw_input(msg)
    else:
        print pkg_help
        sys.exit(0)
    kwds['tmpl_etags'] = etags
    return kwds

def cms::generate

(

kwds

)

Definition at line 87 of file cms.py.

                  :
    "Run generator code based on provided set of arguments"
    config = dict(kwds)
    tmpl   = kwds.get('tmpl')
    stand_alone_group = ['Record', 'Skeleton']
    config.update({'not_in_dir': stand_alone_group})
    if  tmpl in stand_alone_group:
        whereami, ldir = test_cms_environment(tmpl)
        dirs = ldir.split('/')
        config.update({'pkgname': kwds.get('pname')})
        config.update({'subsystem': 'Subsystem'})
        config.update({'pkgname': 'Package'})
        if  whereami:
            if  len(dirs) >= 3:
                config.update({'subsystem': dirs[1]})
                config.update({'pkgname': dirs[2]})
            elif len(dirs) >= 2:
                config.update({'subsystem': dirs[1]})
                config.update({'pkgname': dirs[1]})
    else:
        whereami, ldir = test_cms_environment(tmpl)
        dirs = ldir.split('/')
        if  not dirs or not whereami:
            print cms_error()
            sys.exit(1)
        config.update({'subsystem': dirs[1]})
        config.update({'pkgname': kwds.get('pname')})
        if  whereami in ['src', 'plugins']:
            config.update({'tmpl_files': '.cc'})
            config.update({'pkgname': dirs[2]})
        elif whereami == 'subsystem':
            config.update({'tmpl_files': 'all'})
        else:
            print cms_error()
            sys.exit(1)
    obj = code_generator(config)
    obj.generate()

bool cms::operator!=	(	MD5Result const &	a,
		MD5Result const &	b
	)		[inline]

Definition at line 40 of file Digest.h.

References b.

  {
    return !(a==b);
  }

bool cms::operator<	(	MD5Result const &	a,
		MD5Result const &	b
	)

Definition at line 154 of file Digest.cc.

References cms::MD5Result::bytes.

  {
    return std::lexicographical_compare(a.bytes, 
                                        a.bytes+sizeof(a.bytes), 
                                        b.bytes,
                                        b.bytes+sizeof(b.bytes));
  }

template<typename E , typename T >

detail::Desired<E, detail::is_derived_or_same<Exception,E>::value>::type const& cms::operator<<	(	E const &	e,
		T const &	stuff
	)		[inline]

Definition at line 238 of file Exception.h.

References alignCSCRings::e.

  {
    E& ref = const_cast<E&>(e);
    ref.ost_ << stuff;
    return e;
  }

std::ostream& cms::operator<<	(	std::ostream &	ost,
		Exception const &	e
	)		[inline]

Definition at line 218 of file Exception.h.

References cms::Exception::explainSelf().

  {
    ost << e.explainSelf();
    return ost;
  }

template<typename E >

detail::Desired<E, detail::is_derived_or_same<Exception,E>::value>::type const& cms::operator<<	(	E const &	e,
		std::ios_base &(*)(std::ios_base &)	f
	)		[inline]

Definition at line 277 of file Exception.h.

References alignCSCRings::e, and f.

  {
    E& ref = const_cast<E&>(e);
    f(ref.ost_);
    return e;
  }

template<typename E >

detail::Desired<E, detail::is_derived_or_same<Exception,E>::value>::type& cms::operator<<	(	E &	e,
		std::ios_base &(*)(std::ios_base &)	f
	)		[inline]

Definition at line 267 of file Exception.h.

References alignCSCRings::e, and f.

  {
    f(e.ost_);
    return e;
  }

template<typename E >

detail::Desired<E, detail::is_derived_or_same<Exception,E>::value>::type const& cms::operator<<	(	E const &	e,
		std::ostream &(*)(std::ostream &)	f
	)		[inline]

Definition at line 257 of file Exception.h.

References alignCSCRings::e, and f.

  {
    E& ref = const_cast<E&>(e);
    f(ref.ost_);
    return e;
  }

template<typename E >

detail::Desired<E, detail::is_derived_or_same<Exception,E>::value>::type& cms::operator<<	(	E &	e,
		std::ostream &(*)(std::ostream &)	f
	)		[inline]

Definition at line 248 of file Exception.h.

References alignCSCRings::e, and f.

  {
    f(e.ost_);
    return e;
  }

template<typename E , typename T >

detail::Desired<E, detail::is_derived_or_same<Exception,E>::value>::type& cms::operator<<	(	E &	e,
		T const &	stuff
	)		[inline]

Definition at line 229 of file Exception.h.

References alignCSCRings::e.

  {
    e.ost_ << stuff;
    return e;
  }

std::ostream& cms::operator<<	(	std::ostream &	os,
		MD5Result const &	r
	)		[inline]

Definition at line 46 of file Digest.h.

References cms::MD5Result::toString().

  {
    os << r.toString();
    return os;
  }

bool cms::operator==	(	MD5Result const &	a,
		MD5Result const &	b
	)

Definition at line 148 of file Digest.cc.

References cms::MD5Result::bytes.

  {
    return std::equal(a.bytes, a.bytes+sizeof(a.bytes), b.bytes);
  }

void cms::set_to_default

(

MD5Result &

val

)

Definition at line 44 of file Digest.cc.

References cms::MD5Result::bytes.

Referenced by cms::MD5Result::fromHexifiedString(), and cms::MD5Result::MD5Result().

  {
    val.bytes[0] = 0xd4;
    val.bytes[1] = 0x1d;
    val.bytes[2] = 0x8c;
    val.bytes[3] = 0xd9;
    val.bytes[4] = 0x8f;
    val.bytes[5] = 0x00;
    val.bytes[6] = 0xb2;
    val.bytes[7] = 0x04;
    val.bytes[8] = 0xe9;
    val.bytes[9] = 0x80;
    val.bytes[10] = 0x09;
    val.bytes[11] = 0x98;
    val.bytes[12] = 0xec;
    val.bytes[13] = 0xf8;
    val.bytes[14] = 0x42;
    val.bytes[15] = 0x7e;
  }

def cms::test_cms_environment

(

tmpl

)

Test CMS environment and requirements to run within CMSSW_BASE.
Return True if we fullfill requirements and False otherwise.

Definition at line 59 of file cms.py.

                              :
    """
    Test CMS environment and requirements to run within CMSSW_BASE.
    Return True if we fullfill requirements and False otherwise.
    """
    base = os.environ.get('CMSSW_BASE', None)
    if  not base:
        return False, []
    cdir = os.getcwd()
    ldir = cdir.replace(os.path.join(base, 'src'), '')
    dirs = ldir.split('/')
    # test if we're within CMSSW_BASE/src/SubSystem area
    if  ldir and ldir[0] == '/' and len(dirs) == 2:
        return 'subsystem', ldir
    # test if we're within CMSSW_BASE/src/SubSystem/Pkg area
    if  ldir and ldir[0] == '/' and len(dirs) == 3:
        return 'package', ldir
    # test if we're within CMSSW_BASE/src/SubSystem/Pkg/src area
#    if  ldir and ldir[0] == '/' and len(dirs) == 4 and dirs[-1] == 'src':
#        return 'src', ldir
    # test if we're within CMSSW_BASE/src/SubSystem/Pkg/plugin area
#    if  ldir and ldir[0] == '/' and len(dirs) == 4 and dirs[-1] == 'plugins':
#        return 'plugins', ldir
    # test if we're within CMSSW_BASE/src/SubSystem/Pkg/dir area
    if  ldir and ldir[0] == '/' and len(dirs) == 4:
        return dirs[-1], ldir
    return False, ldir

---

Variable Documentation

const char* cms::s_hexValues = "f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff" [static]

Definition at line 69 of file Digest.cc.

Referenced by cms::MD5Result::toString().