PlusCivcoBrachyStepper Class Reference

#include <src/PlusDataCollection/BrachyTracking/PlusCivcoBrachyStepper.h>

Inheritance diagram for PlusCivcoBrachyStepper:

Collaboration diagram for PlusCivcoBrachyStepper:

Public Member Functions
virtual PlusStatus	Connect ()
virtual PlusStatus	Disconnect ()
virtual PlusStatus	GetDeviceModelInfo (std::string &version, std::string &model, std::string &serial)
virtual PlusStatus	GetEncoderValues (double &PPosition, double &GPosition, double &RPosition, unsigned long &PositionRequestNumber)
virtual PlusStatus	InitializeStepper (std::string &CalibMsg)
virtual PlusStatus	IsStepperAlive ()
	PlusCivcoBrachyStepper (unsigned long COMPort=1, unsigned long BaudRate=9600)
virtual PlusStatus	ResetStepper ()
virtual PlusStatus	SetBaudRate (unsigned long BaudRate)
virtual PlusStatus	SetCOMPort (unsigned long COMPort)
virtual	~PlusCivcoBrachyStepper ()
Public Member Functions inherited from PlusBrachyStepper
BRACHY_STEPPER_TYPE	GetBrachyStepperType () const
	PlusBrachyStepper ()
void	SetBrachyStepperType (BRACHY_STEPPER_TYPE type)
virtual	~PlusBrachyStepper ()

Protected Member Functions
double	ConvertFloatToDecimal (long floatPoint)
long	GetNumberOfSeiDevices ()
PlusStatus	GetSeiDeviceInfo (long devnum, long &model, long &serialnum, long &version, long &addr)

Protected Attributes
long	m_BaudRate
long	m_COMPort
long	m_DeviceAddress
long	m_DeviceNumber
Protected Attributes inherited from PlusBrachyStepper
BRACHY_STEPPER_TYPE	m_BrachyStepperType
unsigned long	m_PositionRequestNumber

Additional Inherited Members
Public Types inherited from PlusBrachyStepper
enum	BRACHY_STEPPER_TYPE {   UNDEFINED_STEPPER, BURDETTE_MEDICAL_SYSTEMS_DIGITAL_STEPPER, BURDETTE_MEDICAL_SYSTEMS_DIGITAL_MOTORIZED_STEPPER, CMS_ACCUSEED_DS300,   CIVCO_STEPPER }
Static Public Member Functions inherited from PlusBrachyStepper
static std::string	GetBrachyStepperTypeInString (BRACHY_STEPPER_TYPE stepperType)

Detailed Description

Definition at line 24 of file PlusCivcoBrachyStepper.h.

Constructor & Destructor Documentation

PlusCivcoBrachyStepper()

PlusCivcoBrachyStepper::PlusCivcoBrachyStepper	(	unsigned long	COMPort = 1,
		unsigned long	BaudRate = 9600
	)

Constructor

Definition at line 14 of file PlusCivcoBrachyStepper.cxx.

~PlusCivcoBrachyStepper()

PlusCivcoBrachyStepper::~PlusCivcoBrachyStepper ( )

virtual

Destructor

Definition at line 27 of file PlusCivcoBrachyStepper.cxx.

Member Function Documentation

Connect()

PlusStatus PlusCivcoBrachyStepper::Connect ( )

virtual

Connect to CIVCO stepper

Implements PlusBrachyStepper.

Definition at line 33 of file PlusCivcoBrachyStepper.cxx.

ConvertFloatToDecimal()

double PlusCivcoBrachyStepper::ConvertFloatToDecimal ( long  floatPoint )

protected

IEEE Standard 754 floating point to double conversion

Definition at line 146 of file PlusCivcoBrachyStepper.cxx.

Disconnect()

PlusStatus PlusCivcoBrachyStepper::Disconnect ( )

virtual

Disconnect from CIVCO stepper

Implements PlusBrachyStepper.

Definition at line 86 of file PlusCivcoBrachyStepper.cxx.

GetDeviceModelInfo()

PlusStatus PlusCivcoBrachyStepper::GetDeviceModelInfo ( std::string &  version, std::string &  model, std::string &  serial  )

virtual

Get device mode information

Implements PlusBrachyStepper.

Definition at line 185 of file PlusCivcoBrachyStepper.cxx.

GetEncoderValues()

PlusStatus PlusCivcoBrachyStepper::GetEncoderValues ( double &  PPosition, double &  GPosition, double &  RPosition, unsigned long &  PositionRequestNumber  )

virtual

Get raw encoder values from stepper

Implements PlusBrachyStepper.

Definition at line 104 of file PlusCivcoBrachyStepper.cxx.

GetNumberOfSeiDevices()

long PlusCivcoBrachyStepper::GetNumberOfSeiDevices ( )

protected

Returns number of devices found on the SEI bus

Definition at line 279 of file PlusCivcoBrachyStepper.cxx.

GetSeiDeviceInfo()

PlusStatus PlusCivcoBrachyStepper::GetSeiDeviceInfo ( long  devnum, long &  model, long &  serialnum, long &  version, long &  addr  )

protected

Get information about the SEI device

Definition at line 285 of file PlusCivcoBrachyStepper.cxx.

InitializeStepper()

PlusStatus PlusCivcoBrachyStepper::InitializeStepper ( std::string &  CalibMsg )

virtual

Initialize stepper

Implements PlusBrachyStepper.

Definition at line 228 of file PlusCivcoBrachyStepper.cxx.

IsStepperAlive()

PlusStatus PlusCivcoBrachyStepper::IsStepperAlive ( )

virtual

Return whether stepper is alive

Implements PlusBrachyStepper.

Definition at line 236 of file PlusCivcoBrachyStepper.cxx.

ResetStepper()

PlusStatus PlusCivcoBrachyStepper::ResetStepper ( )

virtual

Reset stepper

Implements PlusBrachyStepper.

Definition at line 216 of file PlusCivcoBrachyStepper.cxx.

SetBaudRate()

PlusStatus PlusCivcoBrachyStepper::SetBaudRate ( unsigned long  BaudRate )

virtual

Set baud rate of communication

Implements PlusBrachyStepper.

Definition at line 248 of file PlusCivcoBrachyStepper.cxx.

SetCOMPort()

PlusStatus PlusCivcoBrachyStepper::SetCOMPort ( unsigned long  COMPort )

virtual

Set used COM port for communication

Implements PlusBrachyStepper.

Definition at line 265 of file PlusCivcoBrachyStepper.cxx.

Member Data Documentation

m_BaudRate

long PlusCivcoBrachyStepper::m_BaudRate

protected

Baud rate

Definition at line 74 of file PlusCivcoBrachyStepper.h.

m_COMPort

long PlusCivcoBrachyStepper::m_COMPort

protected

Used COM port number

Definition at line 71 of file PlusCivcoBrachyStepper.h.

m_DeviceAddress

long PlusCivcoBrachyStepper::m_DeviceAddress

protected

Device address

Definition at line 80 of file PlusCivcoBrachyStepper.h.

m_DeviceNumber

long PlusCivcoBrachyStepper::m_DeviceNumber

protected

Device number

Definition at line 77 of file PlusCivcoBrachyStepper.h.

---

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

• src/PlusDataCollection/BrachyTracking/PlusCivcoBrachyStepper.h
• src/PlusDataCollection/BrachyTracking/PlusCivcoBrachyStepper.cxx