mitk::USControlInterfaceProbes Class Reference

Interface defining methods for probe selection of ultrasound devices. It consists of methods for getting all available probes and selecting one of them. More...

#include <mitkUSControlInterfaceProbes.h>

Inheritance diagram for mitk::USControlInterfaceProbes:

Collaboration diagram for mitk::USControlInterfaceProbes:

Public Member Functions
	mitkClassMacro (USControlInterfaceProbes, USAbstractControlInterface)
virtual std::vector< USProbe::Pointer >	GetProbeSet ()=0
void	SelectProbe (unsigned int index)
void	SelectProbe (USProbe::Pointer probe)
virtual void	OnSelectProbe (unsigned int index)=0
	Virtual method which is called inside mitk::USControlInterfaceProbes::SelectProbe(). Implement this method to handle the actual selecting of the probe at the device api. More...
virtual void	OnSelectProbe (USProbe::Pointer probe)=0
	Virtual method which is called inside mitk::USControlInterfaceProbes::SelectProbe(). Implement this method to handle the actual selecting of the probe at the device api. More...
virtual USProbe::Pointer	GetSelectedProbe ()=0
virtual unsigned int	GetProbesCount () const =0
Public Member Functions inherited from mitk::USAbstractControlInterface
	mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
virtual void	SetIsActive (bool isActive)=0
virtual bool	GetIsActive ()=0

Protected Member Functions
	USControlInterfaceProbes (itk::SmartPointer< USDevice > device)
	~USControlInterfaceProbes () override
Protected Member Functions inherited from mitk::USAbstractControlInterface
	USAbstractControlInterface (itk::SmartPointer< USDevice > device)
	~USAbstractControlInterface () override

Additional Inherited Members
Protected Attributes inherited from mitk::USAbstractControlInterface
itk::WeakPointer< USDevice >	m_Device

Detailed Description

Interface defining methods for probe selection of ultrasound devices. It consists of methods for getting all available probes and selecting one of them.

All of the methods of this interface must be implemented in a concrete subclass. There are some pure virtual methods in the superclass mitk::USAbstractControlInterface which must be implemente, too.

Definition at line 30 of file mitkUSControlInterfaceProbes.h.

Constructor & Destructor Documentation

USControlInterfaceProbes()

mitk::USControlInterfaceProbes::USControlInterfaceProbes ( itk::SmartPointer< USDevice >  device )

protected

~USControlInterfaceProbes()

mitk::USControlInterfaceProbes::~USControlInterfaceProbes ( )

overrideprotected

Member Function Documentation

GetProbesCount()

virtual unsigned int mitk::USControlInterfaceProbes::GetProbesCount ( ) const

pure virtual

Returns

number of probes currently available at the ultrasound device

Implemented in mitk::USTelemedProbesControls.

GetProbeSet()

virtual std::vector<USProbe::Pointer> mitk::USControlInterfaceProbes::GetProbeSet ( )

pure virtual

Returns

vector of all probes currently available at the ultrasound device

Implemented in mitk::USTelemedProbesControls.

GetSelectedProbe()

virtual USProbe::Pointer mitk::USControlInterfaceProbes::GetSelectedProbe ( )

pure virtual

Returns

Ultrasound probe which is currently selected as the active probe.

Implemented in mitk::USTelemedProbesControls.

mitkClassMacro()

mitk::USControlInterfaceProbes::mitkClassMacro	(	USControlInterfaceProbes	,
		USAbstractControlInterface
	)

OnSelectProbe() [1/2]

virtual void mitk::USControlInterfaceProbes::OnSelectProbe ( unsigned int  index )

pure virtual

Virtual method which is called inside mitk::USControlInterfaceProbes::SelectProbe(). Implement this method to handle the actual selecting of the probe at the device api.

Parameters

index

index of the probe to be selected

Implemented in mitk::USTelemedProbesControls.

OnSelectProbe() [2/2]

virtual void mitk::USControlInterfaceProbes::OnSelectProbe ( USProbe::Pointer  probe )

pure virtual

Virtual method which is called inside mitk::USControlInterfaceProbes::SelectProbe(). Implement this method to handle the actual selecting of the probe at the device api.

Parameters

probe

pointer to probe to be selected

Implemented in mitk::USTelemedProbesControls.

SelectProbe() [1/2]

void mitk::USControlInterfaceProbes::SelectProbe

(

unsigned int

index

)

Select and activate probe by given index. The index corresponds to the the index of the probe in the vector returned by mitk::USControlInterfaceProbes::GetProbeSet().

Do not override this method in a subclass. Implement mitk::USControlInterfaceProbes::OnSelectProbe() instead.

Parameters

index

index of the probe to be selected

SelectProbe() [2/2]

void mitk::USControlInterfaceProbes::SelectProbe

(

USProbe::Pointer

probe

)

Select and activate probe by given mitk::USProbe object. This object can be one of these returned by mitk::USControlInterfaceProbes::GetProbeSet().

Do not override this method in a subclass. Implement mitk::USControlInterfaceProbes::OnSelectProbe() instead.

Parameters

probe

pointer to probe to be selected

---

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

• mitkUSControlInterfaceProbes.h