SctData::RawScanResult Class Reference

A RawScanResult represents the raw data for a single scan. More...

#include <RawScanResult.h>

Inheritance diagram for SctData::RawScanResult:

[legend]Collaboration diagram for SctData::RawScanResult:

[legend]

Public Member Functions
	RawScanResult (const ResultHeader &scanInfo, const ModuleConfiguration &module, const ScanPoints &points, TH2D &scan_link0, TH2D &scan_link1) throw ()
	Creates a RawScanResult object with the given parameters Takes ownership of the scan histograms.
virtual	~RawScanResult () throw ()
	Destroys this object and all its members.
virtual string	getClassName () const throw ()
	Get the class name for this object.
virtual Sct::UniqueID	getUniqueID () const throw ()
	For objects to be stored, there must be some way of identifying them.
TH2D &	getScanData (unsigned link) const throw (LogicError)
	Gets the scan data as a ROOT histogram.
unsigned	nOccupancyPerEvent () const
	returns number of occupancyPerEvent data histograms, usually 0 or 12
TH2D &	getOccupancyPerEvent (unsigned ichip) const throw (LogicError)
	Gets the occupancy histogram data as a ROOT histogram.
UINT16	getDataType () const throw ()
	Get the dataType, as defined in SctApi/dataTypes.h.
Static Public Member Functions
static Sct::UniqueID	getUniqueID (const ResultHeader &header) throw ()
	Gets the unique ID this class would have if it existed and was constructed with header.
Protected Attributes
shared_ptr< TH2D >	scanData_link0
	Scan data for link 0.
shared_ptr< TH2D >	scanData_link1
	Scan data for link 1.
Sct::RangedVector< shared_ptr< TH2D > >	occ_chip
	Occupancy per event for chip.
UINT16	m_dataType
	same as SctApi/dataTypes.h
Private Member Functions
	RawScanResult () throw ()
	Constructor for IO use only.
Friends
class	RawScanResultIOHelper

---

Detailed Description

A RawScanResult represents the raw data for a single scan.

Note that this object (like all others in the package) owns its members (i.e. it will delete them when it is deleted). This can cause problems with the 4 argument constructor if you give it local vars!!!!

Author:

Matthew Palmer

Definition at line 23 of file RawScanResult.h.

---

Constructor & Destructor Documentation

SctData::RawScanResult::RawScanResult (  const ResultHeader &  scanInfo, const ModuleConfiguration &  module, const ScanPoints &  points, TH2D &  scan_link0, TH2D &  scan_link1 )  throw ()

Creates a RawScanResult object with the given parameters Takes ownership of the scan histograms. Definition at line 19 of file RawScanResult.cpp.

SctData::RawScanResult::~RawScanResult (   )  throw () [virtual]

Destroys this object and all its members. Definition at line 27 of file RawScanResult.cpp.

SctData::RawScanResult::RawScanResult (   )  throw () [private]

Constructor for IO use only. Definition at line 24 of file RawScanResult.cpp.

---

Member Function Documentation

string SctData::RawScanResult::getClassName (   )  const throw () [virtual]

Get the class name for this object. This is used to identify the precise type. Returns: the class name Note: Nothrow Implements Sct::Streamable. Definition at line 30 of file RawScanResult.cpp.

UINT16 SctData::RawScanResult::getDataType (   )  const throw ()

Get the dataType, as defined in SctApi/dataTypes.h. Definition at line 43 of file RawScanResult.cpp. References m_dataType. Referenced by SctData::IO::RawScanResultStreamer_v3::write(), and SctData::IO::RawScanResultStreamer_v2::write().

TH2D & SctData::RawScanResult::getOccupancyPerEvent (  unsigned  ichip  )  const throw (LogicError)

Gets the occupancy histogram data as a ROOT histogram. Returns: the scan data Parameters: chip  should be 0 to 11 Exceptions: LogicError  if not available Definition at line 64 of file RawScanResult.cpp.

TH2D & SctData::RawScanResult::getScanData (  unsigned  link  )  const throw (LogicError)

Gets the scan data as a ROOT histogram. Returns: the scan data Exceptions: LogicError  if not available Parameters: link  should be 0 or 1 Definition at line 47 of file RawScanResult.cpp. Referenced by SctAnalysis::MarkSpaceRatioAlgorithm::getAverageOccupancy().

UniqueID SctData::RawScanResult::getUniqueID (  const ResultHeader &  header  )  throw () [static]

Gets the unique ID this class would have if it existed and was constructed with header. Definition at line 39 of file RawScanResult.cpp. References Sct::UniqueID::getUniqueID(). Here is the call graph for this function:

UniqueID SctData::RawScanResult::getUniqueID (   )  const throw () [virtual]

For objects to be stored, there must be some way of identifying them. This function must be implemented to return some unique identifier for objects of this precise className Returns: a unique string for this class Exceptions: LogicError  if the class is unable to generate a uniqueID for some reason Implements Sct::Serializable. Definition at line 34 of file RawScanResult.cpp. References SctData::ScanResult::getHeader(), and SctData::ResultHeader::getUniqueID(). Referenced by SctData::IO::RawScanResultStreamer_v3::setHistSize(), SctData::IO::RawScanResultStreamer_v2::setHistSize(), and SctData::IO::RawScanResultStreamer_v1::setHistSize(). Here is the call graph for this function:

unsigned SctData::RawScanResult::nOccupancyPerEvent (   )  const

returns number of occupancyPerEvent data histograms, usually 0 or 12 Definition at line 60 of file RawScanResult.cpp. References occ_chip. Referenced by SctData::IO::RawScanResultStreamer_v3::write().

---

Field Documentation

UINT16 SctData::RawScanResult::m_dataType [protected]

same as SctApi/dataTypes.h Definition at line 72 of file RawScanResult.h. Referenced by getDataType().

Sct::RangedVector<shared_ptr<TH2D> > SctData::RawScanResult::occ_chip [protected]

Occupancy per event for chip. Definition at line 70 of file RawScanResult.h. Referenced by nOccupancyPerEvent(), and SctData::RawScanResultIOHelper::setNumberOccupancyHists().

shared_ptr<TH2D> SctData::RawScanResult::scanData_link0 [protected]

Scan data for link 0. Definition at line 67 of file RawScanResult.h.

shared_ptr<TH2D> SctData::RawScanResult::scanData_link1 [protected]

Scan data for link 1. Definition at line 68 of file RawScanResult.h.

---

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

• RawScanResult.h
• RawScanResult.cpp

---