Main Page   Modules   Namespace List   Class Hierarchy   Data Structures   File List   Namespace Members   Data Fields   Globals   Related Pages  

SctData::RawScanResult Class Reference

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

#include <RawScanResult.h>

Inheritance diagram for SctData::RawScanResult:

SctData::ScanResult Sct::Serializable Sct::Streamable

Public Member Functions

 RawScanResult (const ScanHeader &scanInfo, const ModuleConfiguration &module, const ScanPoints &points, TH2D &scan_link0, TH2D &scan_link1) throw ()
 Creates a RawScanResult object with the given parameters.

virtual ~RawScanResult () throw ()
 Destroys this object and all its members.

virtual string getClassName () const throw ()
 Get the class name for this object.

virtual string 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.


Static Public Member Functions

string getUniqueID (const ScanHeader &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.


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 ScanHeader   scanInfo,
const ModuleConfiguration   module,
const ScanPoints   points,
TH2D &    scan_link0,
TH2D &    scan_link1
throw ()
 

Creates a RawScanResult object with the given parameters.

Definition at line 22 of file RawScanResult.cpp.

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

Destroys this object and all its members.

Definition at line 30 of file RawScanResult.cpp.

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

Constructor for IO use only.

Definition at line 27 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.

Todo:
We could use typeid instead here, but that would probably mean removing the namespace stuff.
Returns:
the class name

Implements Sct::Streamable.

Definition at line 33 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
Parameters:
link should be 0 or 1

Definition at line 46 of file RawScanResult.cpp.

string SctData::RawScanResult::getUniqueID const ScanHeader   header throw () [static]
 

Gets the unique ID this class would have if it existed and was constructed with header.

Definition at line 42 of file RawScanResult.cpp.

string 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 37 of file RawScanResult.cpp.

Referenced by SctData::IO::RawScanResultStreamer::read().


Friends And Related Function Documentation

friend class RawScanResultIOHelper [friend]
 

Definition at line 82 of file RawScanResult.h.


Field Documentation

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

Scan data for link 0.

Returns a TH1D containing the occupancy.

Definition at line 78 of file RawScanResult.h.

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

Scan data for link 1.

Definition at line 79 of file RawScanResult.h.


The documentation for this class was generated from the following files:
Generated on Mon Dec 15 19:37:49 2003 for SCT DAQ/DCS Software by doxygen1.3-rc3