---

SctData::ScanResult Class Reference

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

#include <ScanResult.h>

Inheritance diagram for SctData::ScanResult:

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

---

Detailed Description

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

Author:

Matthew Palmer

Date:

28/02/2003

Definition at line 17 of file ScanResult.h.

---

Constructor & Destructor Documentation

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

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

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

Copy constructor. Definition at line 11 of file ScanResult.cpp.

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

Definition at line 16 of file ScanResult.cpp.

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

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

---

Member Function Documentation

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

Returns the module configuration. Definition at line 35 of file ScanResult.h. Referenced by SctData::IO::ScanResultStreamer::write().

const ScanHeader& SctData::ScanResult::getHeader (    )  const throw () [inline]

Retrieves the scan-header object. Definition at line 32 of file ScanResult.h. Referenced by SctData::IO::ScanResultStreamer::write().

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

Get the ScanPoints object. Definition at line 39 of file ScanResult.h. References points. Referenced by SctData::IO::RawScanResultStreamer::read(), and SctData::IO::ScanResultStreamer::write().

---

Friends And Related Function Documentation

friend class ScanResultIOHelper [friend]

Definition at line 48 of file ScanResult.h.

---

Field Documentation

const ScanHeader SctData::ScanResult::header [protected]

The ScanHeader that identifies this ScanResult. Definition at line 42 of file ScanResult.h. Referenced by SctData::ScanResultIOHelper::getHeader().

const ModuleConfiguration SctData::ScanResult::moduleConfig [protected]

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

const ScanPoints SctData::ScanResult::points [protected]

The scan points. Definition at line 44 of file ScanResult.h. Referenced by SctData::ScanResultIOHelper::getPoints(), and getPoints().

---

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

• ScanResult.h
• ScanResult.cpp

---