SctApi::Scan Class Reference

Scan class. More...

#include <SctApi.h>

Inheritance diagram for SctApi::Scan:

[legend]

Public Types
typedef std::vector< FLOAT32 >	ScanPoints
	Typedef for list of scan points.
typedef std::vector< UINT32 >	TrigPoints
	Typedef for list of scan points.
enum	ScanOptions {   FULL, BITS32, LOOPCALLINE, DISTSLAVE,   DEBUG, TIM }
	Current options for a scan request. More...
Public Member Functions
virtual void	configure (unsigned short type, float start, float stop, float step)=0
virtual void	configure2 (unsigned short type, float start, float stop, float step)=0
virtual const boost::shared_ptr< Trigger >	getTrigger1 () const=0
virtual const boost::shared_ptr< Trigger >	getTrigger2 () const=0
virtual boost::shared_ptr< Trigger >	getTrigger1 ()=0
virtual boost::shared_ptr< Trigger >	getTrigger2 ()=0
virtual void	setTrigger1 (boost::shared_ptr< Trigger > trigger)=0
virtual void	setTrigger2 (boost::shared_ptr< Trigger > trigger)=0
virtual void	setScanVariable1 (unsigned short var)=0
virtual void	setScanVariable2 (unsigned short var)=0
virtual unsigned short	getScanVariable1 () const=0
virtual unsigned short	getScanVariable2 () const=0
virtual void	setNTrigs (unsigned long nTrigs)=0
virtual unsigned long	getNTrigs () const=0
virtual const TrigPoints	getVariableTrigs () const=0
virtual void	setVariableTrigs (const TrigPoints &scans)=0
virtual void	setVariableTrigRange (unsigned short start, unsigned short end, unsigned long value)=0
virtual const ScanPoints	getScanPoints1 () const=0
virtual const ScanPoints	getScanPoints2 () const=0
virtual void	setScanPoints1 (const ScanPoints &scans)=0
virtual void	setScanPoints2 (const ScanPoints &scans)=0
virtual int	getOption (enum ScanOptions) const=0
virtual void	setOption (enum ScanOptions, int option)=0
virtual void	print () const=0
	Print the scan.
virtual void	setScanNumber (unsigned int scan)=0
virtual unsigned int	getScanNumber () const=0
virtual void	setRunNumber (unsigned int scan)=0
virtual unsigned int	getRunNumber () const=0
virtual std::list< std::string >	getModuleList (unsigned int group) const=0
virtual void	setModuleList (unsigned int group, std::list< std::string > newList)=0
virtual unsigned int	getNGroups () const=0
virtual void	setNGroups (unsigned int val)=0
virtual boost::posix_time::ptime	getStartTime () const=0
virtual void	setStartTime (boost::posix_time::ptime t)=0
virtual boost::posix_time::ptime	getEndTime () const=0
virtual void	setEndTime (boost::posix_time::ptime t)=0

---

Detailed Description

Scan class.

Describes a scan request

There are two module sets defined by the module group number in the configuration.

Definition at line 113 of file SctApi.h.

---

Member Typedef Documentation

typedef std::vector<FLOAT32> SctApi::Scan::ScanPoints

Typedef for list of scan points. Definition at line 118 of file SctApi.h.

typedef std::vector<UINT32> SctApi::Scan::TrigPoints

Typedef for list of scan points. Definition at line 121 of file SctApi.h.

---

Member Enumeration Documentation

enum SctApi::Scan::ScanOptions

Current options for a scan request. Definition at line 124 of file SctApi.h.

---

Member Function Documentation

virtual void SctApi::Scan::print (   )  const [pure virtual]

Print the scan. Implemented in SctApi::ScanDefImpl.

---

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

• SctApi.h

---