Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::USTelemedBModeControls Class Reference

Implementation of mitk::USControlInterfaceBMode for Telemed ultrasound devices. See documentation of mitk::USControlInterfaceBMode for a description of the interface methods. More...

#include <mitkUSTelemedBModeControls.h>

Inheritance diagram for mitk::USTelemedBModeControls:
Collaboration diagram for mitk::USTelemedBModeControls:

Public Member Functions

 mitkClassMacro (USTelemedBModeControls, USControlInterfaceBMode)
 
 mitkNewMacro1Param (Self, itk::SmartPointer< USTelemedDevice >)
 
virtual void SetIsActive (bool)
 
virtual bool GetIsActive ()
 
virtual double GetScanningFrequency ()
 
virtual void OnSetScanningFrequency (double frequency)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningFrequency. More...
 
virtual std::vector< double > GetScanningFrequencyValues ()
 
virtual double GetScanningPower ()
 
virtual void OnSetScanningPower (double power)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningPower. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningPowerMin ()
 
virtual double GetScanningPowerMax ()
 
virtual double GetScanningPowerTick ()
 
virtual double GetScanningDepth ()
 
virtual void OnSetScanningDepth (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDepth. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual std::vector< double > GetScanningDepthValues ()
 
virtual double GetScanningGain ()
 
virtual void OnSetScanningGain (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningGain. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningGainMin ()
 
virtual double GetScanningGainMax ()
 
virtual double GetScanningGainTick ()
 
virtual double GetScanningRejection ()
 
virtual void OnSetScanningRejection (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningRejection. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningRejectionMin ()
 
virtual double GetScanningRejectionMax ()
 
virtual double GetScanningRejectionTick ()
 
virtual double GetScanningDynamicRange ()
 
virtual void OnSetScanningDynamicRange (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDynamicRange. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningDynamicRangeMin ()
 
virtual double GetScanningDynamicRangeMax ()
 
virtual double GetScanningDynamicRangeTick ()
 
void SetUsgDataView (Usgfw2Lib::IUsgDataView *)
 Setter for the IUsgDataView necesary for communicating with the Telemed API. This method is just for internal use of the mitk::USTelemedDevice. More...
 
void ReinitializeControls ()
 
- Public Member Functions inherited from mitk::USControlInterfaceBMode
 mitkClassMacro (USControlInterfaceBMode, USAbstractControlInterface)
 
void Initialize ()
 Initializes the microservice properties with the current values from the device. This method must be called before one would like to get the b mode values (e.g. frequency, power, ...) from the microservice and after the device is ready to deliver the values by the methods of this control interface. More...
 
void SetScanningFrequency (double frequency)
 
void SetScanningPower (double power)
 
void SetScanningDepth (double depth)
 
void SetScanningGain (double gain)
 
void SetScanningRejection (double rejection)
 
virtual void SetScanningDynamicRange (double dynamicRange)
 
- Public Member Functions inherited from mitk::USAbstractControlInterface
 mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
 

Protected Member Functions

 USTelemedBModeControls (itk::SmartPointer< USTelemedDevice > device)
 
virtual ~USTelemedBModeControls ()
 
void CreateControls ()
 
void ReleaseControls ()
 
double GetScanningFrequencyAPI ()
 
- Protected Member Functions inherited from mitk::USControlInterfaceBMode
 USControlInterfaceBMode (itk::SmartPointer< USDevice > device)
 
virtual ~USControlInterfaceBMode ()
 
- Protected Member Functions inherited from mitk::USAbstractControlInterface
 USAbstractControlInterface (itk::SmartPointer< USDevice > device)
 
virtual ~USAbstractControlInterface ()
 

Protected Attributes

Usgfw2Lib::IUsgDataView * m_UsgDataView
 
Usgfw2Lib::IUsgPower * m_PowerControl
 
Usgfw2Lib::IUsgProbeFrequency2 * m_FrequencyControl
 
Usgfw2Lib::IUsgDepth * m_DepthControl
 
Usgfw2Lib::IUsgGain * m_GainControl
 
Usgfw2Lib::IUsgRejection2 * m_RejectionControl
 
Usgfw2Lib::IUsgDynamicRange * m_DynamicRangeControl
 
bool m_Active
 
double * m_PowerSteps
 
double * m_GainSteps
 
double * m_RejectionSteps
 
double * m_DynamicRangeSteps
 
- Protected Attributes inherited from mitk::USAbstractControlInterface
itk::SmartPointer< USDevicem_Device
 

Detailed Description

Implementation of mitk::USControlInterfaceBMode for Telemed ultrasound devices. See documentation of mitk::USControlInterfaceBMode for a description of the interface methods.

Definition at line 32 of file mitkUSTelemedBModeControls.h.

Constructor & Destructor Documentation

mitk::USTelemedBModeControls::USTelemedBModeControls ( itk::SmartPointer< USTelemedDevice device)
protected

Definition at line 23 of file mitkUSTelemedBModeControls.cpp.

mitk::USTelemedBModeControls::~USTelemedBModeControls ( )
protectedvirtual

Definition at line 34 of file mitkUSTelemedBModeControls.cpp.

Member Function Documentation

void mitk::USTelemedBModeControls::CreateControls ( )
protected
bool mitk::USTelemedBModeControls::GetIsActive ( )
virtual
Returns
true if API controls are created and scan mode is set to b mode

Implements mitk::USAbstractControlInterface.

Definition at line 81 of file mitkUSTelemedBModeControls.cpp.

References mitkThrow.

double mitk::USTelemedBModeControls::GetScanningDepth ( )
virtual
Returns
current depth value

Implements mitk::USControlInterfaceBMode.

Definition at line 137 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedValue.

std::vector< double > mitk::USTelemedBModeControls::GetScanningDepthValues ( )
virtual
Returns
vector of all possible depth values for the utrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 147 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedAvailableValues.

double mitk::USTelemedBModeControls::GetScanningDynamicRange ( )
virtual
Returns
current scanning dynamic range

Implements mitk::USControlInterfaceBMode.

Definition at line 202 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedValue.

double mitk::USTelemedBModeControls::GetScanningDynamicRangeMax ( )
virtual
Returns
maximum dynamic range value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 217 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningDynamicRangeMin ( )
virtual
Returns
minimum dynamic range value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 212 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningDynamicRangeTick ( )
virtual
Returns
interval between two dynamic range values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 222 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningFrequency ( )
virtual
Returns
current frequency value

Implements mitk::USControlInterfaceBMode.

Definition at line 97 of file mitkUSTelemedBModeControls.cpp.

References TELEMED_FREQUENCY_FACTOR.

double mitk::USTelemedBModeControls::GetScanningFrequencyAPI ( )
protected

Definition at line 92 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedValue.

std::vector< double > mitk::USTelemedBModeControls::GetScanningFrequencyValues ( )
virtual
Returns
vector of all possible frequency values for the utrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 107 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedAvailableValuesWithFactor, and TELEMED_FREQUENCY_FACTOR.

double mitk::USTelemedBModeControls::GetScanningGain ( )
virtual
Returns
current scanning gain

Implements mitk::USControlInterfaceBMode.

Definition at line 152 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedValue.

double mitk::USTelemedBModeControls::GetScanningGainMax ( )
virtual
Returns
maximum gain value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 167 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningGainMin ( )
virtual
Returns
minimum gain value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 162 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningGainTick ( )
virtual
Returns
interval between two gain values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 172 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningPower ( )
virtual
Returns
current power value

Implements mitk::USControlInterfaceBMode.

Definition at line 112 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedValue.

double mitk::USTelemedBModeControls::GetScanningPowerMax ( )
virtual
Returns
maximum power value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 127 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningPowerMin ( )
virtual
Returns
minimum power value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 122 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningPowerTick ( )
virtual
Returns
interval between two power values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 132 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningRejection ( )
virtual
Returns
current scanning rejection

Implements mitk::USControlInterfaceBMode.

Definition at line 177 of file mitkUSTelemedBModeControls.cpp.

References RETURN_TelemedValue.

double mitk::USTelemedBModeControls::GetScanningRejectionMax ( )
virtual
Returns
maximum rejection value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 192 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningRejectionMin ( )
virtual
Returns
minimum rejection value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 187 of file mitkUSTelemedBModeControls.cpp.

double mitk::USTelemedBModeControls::GetScanningRejectionTick ( )
virtual
Returns
interval between two rejection values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 197 of file mitkUSTelemedBModeControls.cpp.

mitk::USTelemedBModeControls::mitkClassMacro ( USTelemedBModeControls  ,
USControlInterfaceBMode   
)
mitk::USTelemedBModeControls::mitkNewMacro1Param ( Self  ,
itk::SmartPointer< USTelemedDevice  
)
void mitk::USTelemedBModeControls::OnSetScanningDepth ( double  depth)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDepth. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 142 of file mitkUSTelemedBModeControls.cpp.

References SET_TelemedValue.

void mitk::USTelemedBModeControls::OnSetScanningDynamicRange ( double  dynamicRange)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDynamicRange. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 207 of file mitkUSTelemedBModeControls.cpp.

References SET_TelemedValue.

void mitk::USTelemedBModeControls::OnSetScanningFrequency ( double  frequency)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningFrequency.

Implements mitk::USControlInterfaceBMode.

Definition at line 102 of file mitkUSTelemedBModeControls.cpp.

References SET_TelemedValue, and TELEMED_FREQUENCY_FACTOR.

void mitk::USTelemedBModeControls::OnSetScanningGain ( double  gain)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningGain. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 157 of file mitkUSTelemedBModeControls.cpp.

References SET_TelemedValue.

void mitk::USTelemedBModeControls::OnSetScanningPower ( double  power)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningPower. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 117 of file mitkUSTelemedBModeControls.cpp.

References SET_TelemedValue.

void mitk::USTelemedBModeControls::OnSetScanningRejection ( double  rejection)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningRejection. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 182 of file mitkUSTelemedBModeControls.cpp.

References SET_TelemedValue.

void mitk::USTelemedBModeControls::ReinitializeControls ( )

Definition at line 49 of file mitkUSTelemedBModeControls.cpp.

void mitk::USTelemedBModeControls::ReleaseControls ( )
protected

Definition at line 252 of file mitkUSTelemedBModeControls.cpp.

References SAFE_RELEASE.

void mitk::USTelemedBModeControls::SetIsActive ( bool  active)
virtual

Scan mode is set to b mode when this controls are activated. All necessary controls are created at the Telemed API.

Implements mitk::USAbstractControlInterface.

Definition at line 55 of file mitkUSTelemedBModeControls.cpp.

References mitkThrow.

void mitk::USTelemedBModeControls::SetUsgDataView ( Usgfw2Lib::IUsgDataView *  usgDataView)

Setter for the IUsgDataView necesary for communicating with the Telemed API. This method is just for internal use of the mitk::USTelemedDevice.

Definition at line 44 of file mitkUSTelemedBModeControls.cpp.

Member Data Documentation

bool mitk::USTelemedBModeControls::m_Active
protected

Definition at line 106 of file mitkUSTelemedBModeControls.h.

Usgfw2Lib::IUsgDepth* mitk::USTelemedBModeControls::m_DepthControl
protected

Definition at line 101 of file mitkUSTelemedBModeControls.h.

Usgfw2Lib::IUsgDynamicRange* mitk::USTelemedBModeControls::m_DynamicRangeControl
protected

Definition at line 104 of file mitkUSTelemedBModeControls.h.

double* mitk::USTelemedBModeControls::m_DynamicRangeSteps
protected

Definition at line 111 of file mitkUSTelemedBModeControls.h.

Usgfw2Lib::IUsgProbeFrequency2* mitk::USTelemedBModeControls::m_FrequencyControl
protected

Definition at line 100 of file mitkUSTelemedBModeControls.h.

Usgfw2Lib::IUsgGain* mitk::USTelemedBModeControls::m_GainControl
protected

Definition at line 102 of file mitkUSTelemedBModeControls.h.

double* mitk::USTelemedBModeControls::m_GainSteps
protected

Definition at line 109 of file mitkUSTelemedBModeControls.h.

Usgfw2Lib::IUsgPower* mitk::USTelemedBModeControls::m_PowerControl
protected

Definition at line 99 of file mitkUSTelemedBModeControls.h.

double* mitk::USTelemedBModeControls::m_PowerSteps
protected

Definition at line 108 of file mitkUSTelemedBModeControls.h.

Usgfw2Lib::IUsgRejection2* mitk::USTelemedBModeControls::m_RejectionControl
protected

Definition at line 103 of file mitkUSTelemedBModeControls.h.

double* mitk::USTelemedBModeControls::m_RejectionSteps
protected

Definition at line 110 of file mitkUSTelemedBModeControls.h.

Usgfw2Lib::IUsgDataView* mitk::USTelemedBModeControls::m_UsgDataView
protected

Definition at line 98 of file mitkUSTelemedBModeControls.h.


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