CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes | Friends
pos::PixelMaskBase Class Referenceabstract

This is the documentation about PixelMaskBase... More...

#include <PixelMaskBase.h>

Inheritance diagram for pos::PixelMaskBase:
pos::PixelConfigBase pos::PixelMaskAllPixels

Public Member Functions

virtual const PixelROCMaskBitsgetMaskBits (int ROCId) const =0
 
virtual PixelROCMaskBitsgetMaskBits (PixelROCName name)=0
 
 PixelMaskBase (std::string description, std::string creator, std::string date)
 
void setOverride (PixelMaskOverrideBase *)
 
void writeASCII (std::string filename) const override=0
 
virtual void writeBinary (std::string filename) const =0
 
void writeXML (pos::PixelConfigKey key, int version, std::string path) const override
 
void writeXML (std::ofstream *out, std::ofstream *out1=nullptr, std::ofstream *out2=nullptr) const override
 
void writeXMLHeader (pos::PixelConfigKey key, int version, std::string path, std::ofstream *out, std::ofstream *out1=nullptr, std::ofstream *out2=nullptr) const override
 
void writeXMLTrailer (std::ofstream *out, std::ofstream *out1=nullptr, std::ofstream *out2=nullptr) const override
 
 ~PixelMaskBase () override
 
- Public Member Functions inherited from pos::PixelConfigBase
std::string creator ()
 
std::string date ()
 
std::string description ()
 
std::string getAuthor () const
 
std::string getComment () const
 
 PixelConfigBase (std::string description, std::string creator, std::string date)
 
void setAuthor (std::string author)
 
void setComment (std::string comment)
 
virtual void writeXML (std::ofstream *out) const
 
virtual void writeXMLHeader (pos::PixelConfigKey key, int version, std::string path, std::ofstream *out) const
 
virtual void writeXMLTrailer (std::ofstream *out) const
 
virtual ~PixelConfigBase ()
 

Private Attributes

PixelMaskOverrideBasemaskOverride_
 

Friends

std::ostream & operator<< (std::ostream &s, const PixelMaskBase &mask)
 

Detailed Description

This is the documentation about PixelMaskBase...

" "

This class provide a base class for the pixel mask data for the pixel FEC configuration This is a pure interface (abstract class) that needs to have an implementation.

All applications should just use this interface and not care about the specific implementation

Definition at line 36 of file PixelMaskBase.h.

Constructor & Destructor Documentation

◆ PixelMaskBase()

PixelMaskBase::PixelMaskBase ( std::string  description,
std::string  creator,
std::string  date 
)

Definition at line 17 of file PixelMaskBase.cc.

◆ ~PixelMaskBase()

PixelMaskBase::~PixelMaskBase ( )
override

Definition at line 20 of file PixelMaskBase.cc.

20 {}

Member Function Documentation

◆ getMaskBits() [1/2]

virtual const PixelROCMaskBits& pos::PixelMaskBase::getMaskBits ( int  ROCId) const
pure virtual

◆ getMaskBits() [2/2]

virtual PixelROCMaskBits* pos::PixelMaskBase::getMaskBits ( PixelROCName  name)
pure virtual

Implemented in pos::PixelMaskAllPixels.

◆ setOverride()

void PixelMaskBase::setOverride ( PixelMaskOverrideBase override)

Definition at line 22 of file PixelMaskBase.cc.

22 { maskOverride_ = override; }

References maskOverride_.

◆ writeASCII()

void pos::PixelMaskBase::writeASCII ( std::string  filename) const
overridepure virtual

Implements pos::PixelConfigBase.

Implemented in pos::PixelMaskAllPixels.

◆ writeBinary()

virtual void pos::PixelMaskBase::writeBinary ( std::string  filename) const
pure virtual

Implemented in pos::PixelMaskAllPixels.

◆ writeXML() [1/2]

void pos::PixelMaskBase::writeXML ( pos::PixelConfigKey  key,
int  version,
std::string  path 
) const
inlineoverridevirtual

Reimplemented from pos::PixelConfigBase.

Definition at line 51 of file PixelMaskBase.h.

51 { ; }

◆ writeXML() [2/2]

void pos::PixelMaskBase::writeXML ( std::ofstream *  out,
std::ofstream *  out1 = nullptr,
std::ofstream *  out2 = nullptr 
) const
inlineoverridevirtual

Reimplemented from pos::PixelConfigBase.

Definition at line 60 of file PixelMaskBase.h.

60 { ; }

◆ writeXMLHeader()

void pos::PixelMaskBase::writeXMLHeader ( pos::PixelConfigKey  key,
int  version,
std::string  path,
std::ofstream *  out,
std::ofstream *  out1 = nullptr,
std::ofstream *  out2 = nullptr 
) const
inlineoverridevirtual

Reimplemented from pos::PixelConfigBase.

Definition at line 52 of file PixelMaskBase.h.

57  {
58  ;
59  }

◆ writeXMLTrailer()

void pos::PixelMaskBase::writeXMLTrailer ( std::ofstream *  out,
std::ofstream *  out1 = nullptr,
std::ofstream *  out2 = nullptr 
) const
inlineoverridevirtual

Reimplemented from pos::PixelConfigBase.

Definition at line 61 of file PixelMaskBase.h.

63  {
64  ;
65  }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  s,
const PixelMaskBase mask 
)
friend

Definition at line 24 of file PixelMaskBase.cc.

24  {
25  s << mask.getMaskBits(0) << std::endl;
26 
27  return s;
28 }

Member Data Documentation

◆ maskOverride_

PixelMaskOverrideBase* pos::PixelMaskBase::maskOverride_
private

Definition at line 71 of file PixelMaskBase.h.

Referenced by setOverride().

pos::PixelMaskBase::maskOverride_
PixelMaskOverrideBase * maskOverride_
Definition: PixelMaskBase.h:71
pos::PixelConfigBase::date
std::string date()
pos::PixelMaskBase::getMaskBits
virtual const PixelROCMaskBits & getMaskBits(int ROCId) const =0
alignCSCRings.s
s
Definition: alignCSCRings.py:92
pos::PixelConfigBase::creator
std::string creator()
pos::PixelConfigBase::PixelConfigBase
PixelConfigBase(std::string description, std::string creator, std::string date)
Definition: PixelConfigBase.cc:15
pos::PixelConfigBase::description
std::string description()