Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::USAbstractControlInterface Class Referenceabstract

Superclass for all ultrasound device control interfaces. Defines an interface for activating and deactivating a control interface. More...

#include <mitkUSAbstractControlInterface.h>

Inheritance diagram for mitk::USAbstractControlInterface:
Inheritance graph
[legend]
Collaboration diagram for mitk::USAbstractControlInterface:
Collaboration graph
[legend]

Public Member Functions

 mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
 
virtual void SetIsActive (bool isActive)=0
 
virtual bool GetIsActive ()=0
 

Protected Member Functions

 USAbstractControlInterface (itk::SmartPointer< USDevice > device)
 
 ~USAbstractControlInterface () override
 

Protected Attributes

itk::WeakPointer< USDevice > m_Device
 

Detailed Description

Superclass for all ultrasound device control interfaces. Defines an interface for activating and deactivating a control interface.

Definition at line 32 of file mitkUSAbstractControlInterface.h.

Constructor & Destructor Documentation

◆ USAbstractControlInterface()

mitk::USAbstractControlInterface::USAbstractControlInterface ( itk::SmartPointer< USDevice >  device)
protected

Definition at line 16 of file mitkUSAbstractControlInterface.cpp.

◆ ~USAbstractControlInterface()

mitk::USAbstractControlInterface::~USAbstractControlInterface ( )
overrideprotected

Definition at line 21 of file mitkUSAbstractControlInterface.cpp.

Member Function Documentation

◆ GetIsActive()

virtual bool mitk::USAbstractControlInterface::GetIsActive ( )
pure virtual

Method must be implemented in every control interface to tell the caller if the interface is currently activated or deactivated.

Returns
whether the control interface is active or not

Implemented in mitk::USDiPhASDeviceCustomControls, mitk::USDiPhASCustomControls, mitk::USVideoDeviceCustomControls, mitk::USTelemedBModeControls, mitk::USDiPhASProbesControls, mitk::USTelemedProbesControls, and mitk::USTelemedDopplerControls.

◆ mitkClassMacroItkParent()

mitk::USAbstractControlInterface::mitkClassMacroItkParent ( USAbstractControlInterface  ,
itk::Object   
)

◆ SetIsActive()

virtual void mitk::USAbstractControlInterface::SetIsActive ( bool  isActive)
pure virtual

Method must be implemented in every control interface to handle all activities which should be done on activating and deactivating the concrete control interface.

Parameters
isActivewhether the control interface should be activated or deactivated

Implemented in mitk::USDiPhASCustomControls, mitk::USDiPhASProbesControls, mitk::USVideoDeviceCustomControls, mitk::USDiPhASDeviceCustomControls, mitk::USTelemedBModeControls, mitk::USTelemedProbesControls, and mitk::USTelemedDopplerControls.

Member Data Documentation

◆ m_Device

itk::WeakPointer<USDevice> mitk::USAbstractControlInterface::m_Device
protected

Definition at line 56 of file mitkUSAbstractControlInterface.h.

Referenced by mitk::USVideoDeviceCustomControls::GetCropArea(), mitk::USVideoDeviceCustomControls::GetDepthsForProbe(), mitk::USVideoDeviceCustomControls::GetProbes(), mitk::USControlInterfaceBMode::Initialize(), mitk::USControlInterfaceProbes::SelectProbe(), mitk::USVideoDeviceCustomControls::SetDefaultProbeAsCurrentProbe(), mitk::USVideoDeviceCustomControls::SetNewDepth(), mitk::USVideoDeviceCustomControls::SetNewProbeIdentifier(), mitk::USControlInterfaceBMode::SetScanningDepth(), mitk::USControlInterfaceBMode::SetScanningDynamicRange(), mitk::USControlInterfaceBMode::SetScanningFrequency(), mitk::USControlInterfaceBMode::SetScanningGain(), mitk::USControlInterfaceBMode::SetScanningPower(), mitk::USControlInterfaceBMode::SetScanningRejection(), mitk::USVideoDeviceCustomControls::UpdateProbeCropping(), and mitk::USVideoDeviceCustomControls::USVideoDeviceCustomControls().

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