ScanWrapper Class Reference

The class ScanWrapper is designed to look externally like a SctApi::Scan (i.e. More...

#include <ScanWrapper.h>

Inheritance diagram for ScanWrapper:

[legend]Collaboration diagram for ScanWrapper:

[legend]

Public Types
typedef enum ScanWrapper::MemoryPolicy_enum	MemoryPolicy
typedef ::SctApi::Scan::ScanPoints	ScanPoints
	Typedef for list of scan points.
typedef ::SctApi::Scan::TrigPoints	TrigPoints
	Typedef for list of scan points.
typedef ::SctApi::Scan::ScanOptionsEnum	ScanOptionsEnum
	FULL: if 1 decode three time bins into consecutive histograms.
enum	MemoryPolicy_enum { takeOwnershipOfObjectReference, doNotTakeOwnershipOfObjectReference }
Public Member Functions
	ScanWrapper (Sct_SctApi::Scan_ptr w)
virtual	~ScanWrapper ()
void	configure (unsigned short type, float start, float stop, float step)
void	configure2 (unsigned short type, float start, float stop, float step)
const boost::shared_ptr< ::SctApi::Trigger >	getTrigger1 () const
const boost::shared_ptr< ::SctApi::Trigger >	getTrigger2 () const
boost::shared_ptr< ::SctApi::Trigger >	getTrigger1 ()
boost::shared_ptr< ::SctApi::Trigger >	getTrigger2 ()
void	setTrigger1 (boost::shared_ptr< ::SctApi::Trigger > trigger)
void	setTrigger2 (boost::shared_ptr< ::SctApi::Trigger > trigger)
void	setScanVariable1 (unsigned short var)
void	setScanVariable2 (unsigned short var)
unsigned short	getScanVariable1 () const
unsigned short	getScanVariable2 () const
void	setNTrigs (unsigned long nTrigs)
unsigned long	getNTrigs () const
const TrigPoints	getVariableTrigs () const
void	setVariableTrigs (const TrigPoints &scans)
void	setVariableTrigRange (unsigned short start, unsigned short end, unsigned long value)
const ScanPoints	getScanPoints1 () const
const ScanPoints	getScanPoints2 () const
void	setScanPoints1 (const ScanPoints &scans)
void	setScanPoints2 (const ScanPoints &scans)
int	getOption (ScanOptionsEnum scanOption) const
void	setOption (ScanOptionsEnum scanOption, int option)
std::string	print () const
	Print the scan.
void	setScanNumber (unsigned int scan)
unsigned int	getScanNumber () const
void	setRunNumber (unsigned int scan)
unsigned int	getRunNumber () const
::SctApi::ModuleList	getModuleList (unsigned int group) const
void	setModuleList (unsigned int group, const ::SctApi::ModuleList &newList)
unsigned int	getNGroups () const
void	setNGroups (unsigned int val)
boost::posix_time::ptime	getStartTime () const
void	setStartTime (boost::posix_time::ptime t)
boost::posix_time::ptime	getEndTime () const
void	setEndTime (boost::posix_time::ptime t)
Private Member Functions
Sct_SctApi::Scan_ptr	corbaScanServer () const
Sct_SctApi::Scan_ptr	corbaScanServer ()
Private Attributes
const MemoryPolicy	m_memoryPolicy
Sct_SctApi::Scan_var	m_worker

---

Detailed Description

The class ScanWrapper is designed to look externally like a SctApi::Scan (i.e.

implement the SctApiScan interface) while actually just passing all these calls through to a CORBA scan object, which is itself internally implemented by a "standard" SctApi scan object!

This class DOES NOT OWN the object reference which it is constructed with! An alternative strategy could be developed ...

Author:

Christopher Lester

Definition at line 27 of file ScanWrapper.h.

---

Member Typedef Documentation

typedef ::SctApi::Scan::ScanOptionsEnum ScanWrapper::ScanOptionsEnum

FULL: if 1 decode three time bins into consecutive histograms. BITS32: 0 -> 16 bits 1 -> 32 bits LOOPCALLINE: Do a loop over the calibration line for each bin DISTSLAVE: 0 -> All to slave 0 1 -> Group distribution 2 -> Router distribution DEBUG: If scan doesn't complete drop into debug mode TIM: Triggers sent by TIM NTH: Histogram every nth trigger (only in router distribution mode) NTH_REM: Remainder for nth trigger ENABLE_DATA_MODE: Normally true. Says that when the module is configured, the module will go into data-returning mode. The alternative (false) puts the module in return-configuration-register-id mode. USE_CCODE: if non-zero the c-code (rather than assembly) routine for histogramming OPE: if non-zero then occupancy-per-event will be histogrammed. Reimplemented from SctApi::Scan. Definition at line 42 of file ScanWrapper.h.

typedef ::SctApi::Scan::ScanPoints ScanWrapper::ScanPoints

Typedef for list of scan points. Reimplemented from SctApi::Scan. Definition at line 38 of file ScanWrapper.h.

typedef ::SctApi::Scan::TrigPoints ScanWrapper::TrigPoints

Typedef for list of scan points. Reimplemented from SctApi::Scan. Definition at line 41 of file ScanWrapper.h.

---

Member Function Documentation

std::string ScanWrapper::print (   )  const [virtual]

Print the scan. Implements SctApi::Scan.

---

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

• ScanWrapper.h

---