SctData::ScanResult Class Reference

This class represents all possible things what might come out of a ROD. More...

#include <ScanResult.h>

Inheritance diagram for SctData::ScanResult:

[legend]Collaboration diagram for SctData::ScanResult:

[legend]

Public Member Functions
	ScanResult (const ResultHeader &header, const ModuleConfiguration &moduleConfig, const ScanPoints &points)
	Creates a ScanResult by copying the header and module configuration.
	ScanResult (const ScanResult &copyMe)
	Copy constructor.
virtual const ResultHeader &	getHeader () const
	Retrieves the scan-header object.
virtual ResultHeader &	getHeader ()
	Retrieves the scan-header object.
const ModuleConfiguration &	getConfiguration () const
	Returns the module configuration.
ModuleConfiguration &	getConfiguration ()
	Returns the configuration.
const ScanPoints &	getPoints () const throw ()
	Get the ScanPoints object.
ScanPoints &	getPoints ()
	Gets the ScanPoints object.
Protected Member Functions
	ScanResult ()
	For IO use only.
Private Attributes
ResultHeader	header
	The ScanHeader that identifies this ScanResult.
ModuleConfiguration	moduleConfig
	The ModuleConfiguration of the module referred to in the header.
ScanPoints	points
	The scan points.

---

Detailed Description

This class represents all possible things what might come out of a ROD.

Author:

Matthew Palmer

Date:

28/02/2003

Definition at line 16 of file ScanResult.h.

---

Constructor & Destructor Documentation

SctData::ScanResult::ScanResult (  const ResultHeader &  header, const ModuleConfiguration &  moduleConfig, const ScanPoints &  points )

Creates a ScanResult by copying the header and module configuration. Note: Nothrow Definition at line 6 of file ScanResult.cpp.

SctData::ScanResult::ScanResult (  const ScanResult &  copyMe  )

Copy constructor. Note: Nothrow Definition at line 11 of file ScanResult.cpp.

SctData::ScanResult::ScanResult (   )  [protected]

For IO use only. Definition at line 17 of file ScanResult.cpp.

---

Member Function Documentation

ModuleConfiguration& SctData::ScanResult::getConfiguration (   )  [inline]

Returns the configuration. Note: Nothrow Definition at line 50 of file ScanResult.h. References moduleConfig.

const ModuleConfiguration& SctData::ScanResult::getConfiguration (   )  const [inline]

Returns the module configuration. Note: Nothrow Definition at line 45 of file ScanResult.h. References moduleConfig. Referenced by SctData::IO::ScanResultStreamer_v1::read(), and SctData::IO::ScanResultStreamer_v1::write().

virtual ResultHeader& SctData::ScanResult::getHeader (   )  [inline, virtual]

Retrieves the scan-header object. Note: Nothrow Implements SctData::Result. Definition at line 39 of file ScanResult.h. References header.

virtual const ResultHeader& SctData::ScanResult::getHeader (   )  const [inline, virtual]

Retrieves the scan-header object. Note: Nothrow Implements SctData::Result. Definition at line 34 of file ScanResult.h. References header. Referenced by FitCompare::compare(), CheckRaw::compare(), NagRootCompare::compareFits(), SctData::IO::RawScanResultStreamer_v3::createOccupancyHistogram(), SctDataDisplay::FitDisplayer::displayChannels(), SctDataDisplay::FitDisplayer::displayChips(), SctData::RawScanResult::getUniqueID(), SctData::FitScanResult::getUniqueID(), SctData::IO::ScanResultStreamer_v1::read(), and SctData::IO::ScanResultStreamer_v1::write().

ScanPoints& SctData::ScanResult::getPoints (   )  [inline]

Gets the ScanPoints object. Note: Nothrow Definition at line 61 of file ScanResult.h. References points.

const ScanPoints& SctData::ScanResult::getPoints (   )  const throw () [inline]

Get the ScanPoints object. Note: Nothrow Definition at line 56 of file ScanResult.h. References points. Referenced by SctAnalysis::MarkSpaceRatioAlgorithm::getAverageOccupancy(), SctData::IO::ScanResultStreamer_v1::read(), SctData::IO::RawScanResultStreamer_v3::readRawData(), SctData::IO::RawScanResultStreamer_v2::readRawData(), SctData::IO::RawScanResultStreamer_v1::readRawData(), SctData::IO::RawScanResultStreamer_v3::readRootData(), SctData::IO::RawScanResultStreamer_v2::readRootData(), SctData::IO::RawScanResultStreamer_v1::readRootData(), SctData::IO::RawScanResultStreamer_v3::readSliceData(), SctData::IO::RawScanResultStreamer_v2::readSliceData(), SctData::IO::RawScanResultStreamer_v1::readSliceData(), SctData::IO::RawScanResultStreamer_v3::setHistSize(), SctData::IO::RawScanResultStreamer_v2::setHistSize(), SctData::IO::RawScanResultStreamer_v1::setHistSize(), and SctData::IO::ScanResultStreamer_v1::write().

---

Field Documentation

ResultHeader SctData::ScanResult::header [private]

The ScanHeader that identifies this ScanResult. Definition at line 67 of file ScanResult.h. Referenced by getHeader().

ModuleConfiguration SctData::ScanResult::moduleConfig [private]

The ModuleConfiguration of the module referred to in the header. Definition at line 68 of file ScanResult.h. Referenced by getConfiguration().

ScanPoints SctData::ScanResult::points [private]

The scan points. Definition at line 69 of file ScanResult.h. Referenced by getPoints().

---

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

• ScanResult.h
• ScanResult.cpp

---