---

SctApi::Scan Class Reference

Scan class. More...

#include <SctApi.h>

Inheritance diagram for SctApi::Scan:

Public Types
typedef std::vector< FLOAT32 >	ScanPoints
	Typedef for list of scan points.
enum	ScanOptions {   FORMAT, FULL, BITS32, LOOPCALLINE,   DISTSLAVE, DEBUG }
	Current options for a scan request. More...
Public Member Functions
virtual	~Scan ()
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 Trigger *	getTrigger1 () const=0
virtual const Trigger *	getTrigger2 () const=0
virtual Trigger *	getTrigger1 ()=0
virtual Trigger *	getTrigger2 ()=0
virtual void	setTrigger1 (Trigger *trigger)=0
virtual void	setTrigger2 (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 short	getNTrigs () const=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

---

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 79 of file SctApi.h.

---

Member Typedef Documentation

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

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

---

Member Enumeration Documentation

enum SctApi::Scan::ScanOptions

Current options for a scan request. Enumeration values: FORMAT  FULL  BITS32  LOOPCALLINE  DISTSLAVE  DEBUG  Definition at line 87 of file SctApi.h.

---

Constructor & Destructor Documentation

virtual SctApi::Scan::~Scan (    )  [virtual]

---

Member Function Documentation

virtual void SctApi::Scan::configure (  unsigned short    type, float    start, float    stop, float    step )  [pure virtual]

virtual void SctApi::Scan::configure2 (  unsigned short    type, float    start, float    stop, float    step )  [pure virtual]

virtual std::list<std::string> SctApi::Scan::getModuleList (  unsigned int    group )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual unsigned int SctApi::Scan::getNGroups (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual unsigned short SctApi::Scan::getNTrigs (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual int SctApi::Scan::getOption (  enum    ScanOptions )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual unsigned int SctApi::Scan::getRunNumber (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual unsigned int SctApi::Scan::getScanNumber (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual const ScanPoints SctApi::Scan::getScanPoints1 (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual const ScanPoints SctApi::Scan::getScanPoints2 (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual unsigned short SctApi::Scan::getScanVariable1 (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual unsigned short SctApi::Scan::getScanVariable2 (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual Trigger* SctApi::Scan::getTrigger1 (    )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual const Trigger* SctApi::Scan::getTrigger1 (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual Trigger* SctApi::Scan::getTrigger2 (    )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual const Trigger* SctApi::Scan::getTrigger2 (    )  const [pure virtual]

Implemented in SctApi::ScanDefImpl.

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

Print the scan. Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setModuleList (  unsigned int    group, std::list< std::string >    newList )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setNGroups (  unsigned int    val )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setNTrigs (  unsigned long    nTrigs )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setOption (  enum    ScanOptions, int    option )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setRunNumber (  unsigned int    scan )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setScanNumber (  unsigned int    scan )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setScanPoints1 (  const ScanPoints &    scans )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setScanPoints2 (  const ScanPoints &    scans )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setScanVariable1 (  unsigned short    var )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setScanVariable2 (  unsigned short    var )  [pure virtual]

Implemented in SctApi::ScanDefImpl.

virtual void SctApi::Scan::setTrigger1 (  Trigger *    trigger )  [pure virtual]

virtual void SctApi::Scan::setTrigger2 (  Trigger *    trigger )  [pure virtual]

---

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

• SctApi.h

---