CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Member Functions | Private Attributes
SiStripHistoTitle Class Reference

Utility class that holds histogram title. More...

#include <SiStripHistoTitle.h>

Public Member Functions

const uint16_t & channel () const
 
const std::string & extraInfo () const
 
const sistrip::Granularitygranularity () const
 
const sistrip::HistoTypehistoType () const
 
const sistrip::KeyTypekeyType () const
 
const uint32_t & keyValue () const
 
const sistrip::RunTyperunType () const
 
 SiStripHistoTitle (const sistrip::HistoType &histo_type, const sistrip::RunType &run_type, const SiStripKey &key, const std::string &extra_info="")
 
 SiStripHistoTitle (const sistrip::HistoType &histo_type, const sistrip::RunType &run_type, const sistrip::KeyType &key_type, const uint32_t &key_value, const sistrip::Granularity &gran, const uint16_t &channel, const std::string &extra_info="")
 
 SiStripHistoTitle (const std::string &histo_title)
 
const std::string & title () const
 

Private Member Functions

void extractTitle ()
 
void setTitle ()
 
 SiStripHistoTitle ()
 

Private Attributes

uint16_t channel_
 
std::string extraInfo_
 
sistrip::Granularity granularity_
 
sistrip::HistoType histoType_
 
sistrip::KeyType keyType_
 
uint32_t keyValue_
 
sistrip::RunType runType_
 
std::string title_
 

Detailed Description

Utility class that holds histogram title.

Author
R.Bainbridge

Definition at line 20 of file SiStripHistoTitle.h.

Constructor & Destructor Documentation

SiStripHistoTitle::SiStripHistoTitle ( const sistrip::HistoType histo_type,
const sistrip::RunType run_type,
const SiStripKey key,
const std::string &  extra_info = "" 
)

Constructs histogram title from key object.

Definition at line 13 of file SiStripHistoTitle.cc.

SiStripHistoTitle::SiStripHistoTitle ( const sistrip::HistoType histo_type,
const sistrip::RunType run_type,
const sistrip::KeyType key_type,
const uint32_t &  key_value,
const sistrip::Granularity gran,
const uint16_t &  channel,
const std::string &  extra_info = "" 
)

Constructs histogram title from various data.

Definition at line 43 of file SiStripHistoTitle.cc.

SiStripHistoTitle::SiStripHistoTitle ( const std::string &  histo_title)

Extracts individual components from histogram title.

Definition at line 64 of file SiStripHistoTitle.cc.

SiStripHistoTitle::SiStripHistoTitle ( )
inlineprivate

Private default constructor.

Definition at line 75 of file SiStripHistoTitle.h.

75 {;}

Member Function Documentation

const uint16_t & SiStripHistoTitle::channel ( ) const
inline

Returns channel for histogram granularity.

Definition at line 119 of file SiStripHistoTitle.h.

References channel_.

119 { return channel_; }
void SiStripHistoTitle::extractTitle ( )
private

Extracts member data values from title.

Definition at line 108 of file SiStripHistoTitle.cc.

const std::string & SiStripHistoTitle::extraInfo ( ) const
inline

Extra information attached to histogram title.

Definition at line 120 of file SiStripHistoTitle.h.

References extraInfo_.

120 { return extraInfo_; }
const sistrip::Granularity & SiStripHistoTitle::granularity ( ) const
inline

Returns granularity of histogram.

Definition at line 118 of file SiStripHistoTitle.h.

References granularity_.

118 { return granularity_; }
sistrip::Granularity granularity_
const sistrip::HistoType & SiStripHistoTitle::histoType ( ) const
inline

Returns the histogram type.

Definition at line 114 of file SiStripHistoTitle.h.

References histoType_.

114 { return histoType_; }
sistrip::HistoType histoType_
const sistrip::KeyType & SiStripHistoTitle::keyType ( ) const
inline

Defines key type used to form the histogram title.

Definition at line 116 of file SiStripHistoTitle.h.

References keyType_.

116 { return keyType_; }
sistrip::KeyType keyType_
const uint32_t & SiStripHistoTitle::keyValue ( ) const
inline

Returns values of the 32-bit key.

Definition at line 117 of file SiStripHistoTitle.h.

References keyValue_.

117 { return keyValue_; }
const sistrip::RunType & SiStripHistoTitle::runType ( ) const
inline

Returns the run type.

Definition at line 115 of file SiStripHistoTitle.h.

References runType_.

115 { return runType_; }
sistrip::RunType runType_
void SiStripHistoTitle::setTitle ( )
private

Constructs histogram title.

Definition at line 79 of file SiStripHistoTitle.cc.

const std::string & SiStripHistoTitle::title ( ) const
inline

Member Data Documentation

uint16_t SiStripHistoTitle::channel_
private

Channel number for granularity.

Definition at line 104 of file SiStripHistoTitle.h.

Referenced by channel().

std::string SiStripHistoTitle::extraInfo_
private

Extra information to be attached to title.

Definition at line 107 of file SiStripHistoTitle.h.

Referenced by extraInfo().

sistrip::Granularity SiStripHistoTitle::granularity_
private

Granularity of histogram.

Definition at line 101 of file SiStripHistoTitle.h.

Referenced by granularity().

sistrip::HistoType SiStripHistoTitle::histoType_
private

Defines histo type.

Definition at line 89 of file SiStripHistoTitle.h.

Referenced by histoType().

sistrip::KeyType SiStripHistoTitle::keyType_
private

Defines key type.

Definition at line 95 of file SiStripHistoTitle.h.

Referenced by keyType().

uint32_t SiStripHistoTitle::keyValue_
private

Key value.

Definition at line 98 of file SiStripHistoTitle.h.

Referenced by keyValue().

sistrip::RunType SiStripHistoTitle::runType_
private

Defines run type.

Definition at line 92 of file SiStripHistoTitle.h.

Referenced by runType().

std::string SiStripHistoTitle::title_
private

Histogram title.

Definition at line 86 of file SiStripHistoTitle.h.

Referenced by title().