mitk::USAbstractControlInterface Class Reference

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:

Collaboration diagram for mitk::USAbstractControlInterface:

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

~USAbstractControlInterface()

mitk::USAbstractControlInterface::~USAbstractControlInterface ( )

overrideprotected

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::USVideoDeviceCustomControls, mitk::USTelemedBModeControls, 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

isActive

whether the control interface should be activated or deactivated

Implemented in mitk::USTelemedBModeControls, mitk::USTelemedProbesControls, mitk::USTelemedDopplerControls, and mitk::USVideoDeviceCustomControls.

Member Data Documentation

m_Device

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

protected

Definition at line 56 of file mitkUSAbstractControlInterface.h.

---

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

• mitkUSAbstractControlInterface.h