SctData::Defect Class Reference

Represents a defect - basically a union of a ModuleElement and a DefectPrototype. More...

#include <Defect.h>

Collaboration diagram for SctData::Defect:

[legend]

Public Member Functions
	Defect (const DefectPrototype &proto, ModuleElement element, boost::optional< double > opt_par=boost::optional< double >::optional())
const ModuleElement &	getModuleElement () const
	Gets the module element affected by this defect.
const DefectPrototype &	getPrototype () const
	Get the DefectPrototype.
bool	operator== (const Defect &defect) const
	Compares two defects returning true if they are the same.
bool	operator!= (const Defect &defect) const
	Compares two defects returning true if they are differenct.
boost::optional< double >	getParameter () const
	Return optional parameter.
void	setParameter (double param)
	Set optional parameter.
Private Attributes
const DefectPrototype *	prototype
	The prototype - pointer to allow assignment operator to work - points to static object so no need to delete.
ModuleElement	element
	The element.
boost::optional< double >	opt_par

---

Detailed Description

Represents a defect - basically a union of a ModuleElement and a DefectPrototype.

Author:

Matthew Palmer Added optional parameter -- to be used for things like Stuck_Cell list, noise of NO_HI channels and so on.

Bilge Demirkoz

Definition at line 20 of file Defect.h.

---

Member Function Documentation

const ModuleElement & SctData::Defect::getModuleElement (   )  const

Gets the module element affected by this defect. Note: Nothrow Definition at line 20 of file Defect.cpp. References element. Referenced by SctData::DefectList::addDefect().

boost::optional< double > SctData::Defect::getParameter (   )  const

Return optional parameter. BD Definition at line 37 of file Defect.cpp. References opt_par.

const DefectPrototype & SctData::Defect::getPrototype (   )  const

Get the DefectPrototype. Note: Nothrow Definition at line 24 of file Defect.cpp. References prototype. Referenced by SctData::DefectList::addDefect().

bool SctData::Defect::operator!= (  const Defect &  defect  )  const

Compares two defects returning true if they are differenct. Note: Nothrow Definition at line 32 of file Defect.cpp.

bool SctData::Defect::operator== (  const Defect &  defect  )  const

Compares two defects returning true if they are the same. Note: Nothrow Definition at line 28 of file Defect.cpp. References element, and prototype.

void SctData::Defect::setParameter (  double  param  )

Set optional parameter. Definition at line 42 of file Defect.cpp. References opt_par.

---

Field Documentation

ModuleElement SctData::Defect::element [private]

The element. Definition at line 58 of file Defect.h. Referenced by getModuleElement(), and operator==().

const DefectPrototype* SctData::Defect::prototype [private]

The prototype - pointer to allow assignment operator to work - points to static object so no need to delete. Definition at line 57 of file Defect.h. Referenced by getPrototype(), and operator==().

---

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

• Defect.h
• Defect.cpp

---