PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
PlusBrachyStepper Class Referenceabstract

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

Inheritance diagram for PlusBrachyStepper:
Inheritance graph
[legend]

Public Types

enum  BRACHY_STEPPER_TYPE {
  UNDEFINED_STEPPER, BURDETTE_MEDICAL_SYSTEMS_DIGITAL_STEPPER, BURDETTE_MEDICAL_SYSTEMS_DIGITAL_MOTORIZED_STEPPER, CMS_ACCUSEED_DS300,
  CIVCO_STEPPER
}
 

Public Member Functions

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

Static Public Member Functions

static std::string GetBrachyStepperTypeInString (BRACHY_STEPPER_TYPE stepperType)
 

Protected Attributes

BRACHY_STEPPER_TYPE m_BrachyStepperType
 
unsigned long m_PositionRequestNumber
 

Detailed Description

Definition at line 17 of file PlusBrachyStepper.h.

Member Enumeration Documentation

◆ BRACHY_STEPPER_TYPE

Stepper type enumeration

Enumerator
UNDEFINED_STEPPER 
BURDETTE_MEDICAL_SYSTEMS_DIGITAL_STEPPER 
BURDETTE_MEDICAL_SYSTEMS_DIGITAL_MOTORIZED_STEPPER 
CMS_ACCUSEED_DS300 
CIVCO_STEPPER 

Definition at line 21 of file PlusBrachyStepper.h.

Constructor & Destructor Documentation

◆ PlusBrachyStepper()

PlusBrachyStepper::PlusBrachyStepper ( )
inline

Constructor

Definition at line 31 of file PlusBrachyStepper.h.

◆ ~PlusBrachyStepper()

virtual PlusBrachyStepper::~PlusBrachyStepper ( )
inlinevirtual

Definition at line 36 of file PlusBrachyStepper.h.

Member Function Documentation

◆ Connect()

virtual PlusStatus PlusBrachyStepper::Connect ( )
pure virtual

Destructor

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ Disconnect()

virtual PlusStatus PlusBrachyStepper::Disconnect ( )
pure virtual

Disconnect from stepper

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ GetBrachyStepperType()

BRACHY_STEPPER_TYPE PlusBrachyStepper::GetBrachyStepperType ( ) const
inline

Definition at line 68 of file PlusBrachyStepper.h.

◆ GetBrachyStepperTypeInString()

static std::string PlusBrachyStepper::GetBrachyStepperTypeInString ( BRACHY_STEPPER_TYPE  stepperType)
inlinestatic

Get brachy stepper type in string format

Definition at line 71 of file PlusBrachyStepper.h.

◆ GetDeviceModelInfo()

virtual PlusStatus PlusBrachyStepper::GetDeviceModelInfo ( std::string &  version,
std::string &  model,
std::string &  serial 
)
pure virtual

Get stepper model specific information from device

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ GetEncoderValues()

virtual PlusStatus PlusBrachyStepper::GetEncoderValues ( double &  PPosition,
double &  GPosition,
double &  RPosition,
unsigned long &  PositionRequestNumber 
)
pure virtual

Get raw encoder values from stepper

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ InitializeStepper()

virtual PlusStatus PlusBrachyStepper::InitializeStepper ( std::string &  CalibMsg)
pure virtual

Initialize stepper

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ IsStepperAlive()

virtual PlusStatus PlusBrachyStepper::IsStepperAlive ( )
pure virtual

Get notification from the stepper

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ ResetStepper()

virtual PlusStatus PlusBrachyStepper::ResetStepper ( )
pure virtual

Reset stepper

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ SetBaudRate()

virtual PlusStatus PlusBrachyStepper::SetBaudRate ( unsigned long  BaudRate)
pure virtual

Set baud rate for communication with the stepper

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

◆ SetBrachyStepperType()

void PlusBrachyStepper::SetBrachyStepperType ( BRACHY_STEPPER_TYPE  type)
inline

Set/get bracy stepper type from BRACHY_STEPPER_TYPE

Definition at line 67 of file PlusBrachyStepper.h.

◆ SetCOMPort()

virtual PlusStatus PlusBrachyStepper::SetCOMPort ( unsigned long  COMPort)
pure virtual

Set COM port number for cummunication with the stepper

Implemented in PlusCmsBrachyStepper, and PlusCivcoBrachyStepper.

Member Data Documentation

◆ m_BrachyStepperType

BRACHY_STEPPER_TYPE PlusBrachyStepper::m_BrachyStepperType
protected

Type of the current brachy stepper

Definition at line 103 of file PlusBrachyStepper.h.

◆ m_PositionRequestNumber

unsigned long PlusBrachyStepper::m_PositionRequestNumber
protected

Number of position requests performed

Definition at line 106 of file PlusBrachyStepper.h.


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