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

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

#include <mitkUSTelemedProbesControls.h>

Inheritance diagram for mitk::USTelemedProbesControls:
Collaboration diagram for mitk::USTelemedProbesControls:

Public Member Functions

 mitkClassMacro (USTelemedProbesControls, USControlInterfaceProbes)
 
 mitkNewMacro1Param (Self, itk::SmartPointer< USTelemedDevice >)
 
virtual void SetIsActive (bool)
 
virtual bool GetIsActive ()
 
virtual std::vector< USProbe::Pointer > GetProbeSet ()
 
virtual void OnSelectProbe (unsigned int index)
 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)
 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 ()
 
virtual unsigned int GetProbesCount () const
 
void ProbeRemoved (unsigned int index)
 
void ProbeAdded (unsigned int index)
 
- Public Member Functions inherited from mitk::USControlInterfaceProbes
 mitkClassMacro (USControlInterfaceProbes, USAbstractControlInterface)
 
void SelectProbe (unsigned int index)
 
void SelectProbe (USProbe::Pointer probe)
 
- Public Member Functions inherited from mitk::USAbstractControlInterface
 mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
 

Protected Member Functions

 USTelemedProbesControls (itk::SmartPointer< USTelemedDevice > device)
 
virtual ~USTelemedProbesControls ()
 
bool CreateProbesCollection ()
 
void CreateProbesSet ()
 
- Protected Member Functions inherited from mitk::USControlInterfaceProbes
 USControlInterfaceProbes (itk::SmartPointer< USDevice > device)
 
virtual ~USControlInterfaceProbes ()
 
- Protected Member Functions inherited from mitk::USAbstractControlInterface
 USAbstractControlInterface (itk::SmartPointer< USDevice > device)
 
virtual ~USAbstractControlInterface ()
 

Protected Attributes

bool m_IsActive
 
unsigned int m_SelectedProbeIndex
 
std::vector< USTelemedProbe::Pointer > m_ProbesSet
 
itk::SmartPointer< USTelemedDevicem_TelemedDevice
 
Usgfw2Lib::IUsgCollection * m_ProbesCollection
 
Usgfw2Lib::IProbe * m_Probe
 
- Protected Attributes inherited from mitk::USAbstractControlInterface
itk::SmartPointer< USDevicem_Device
 

Detailed Description

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

Definition at line 33 of file mitkUSTelemedProbesControls.h.

Constructor & Destructor Documentation

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

Constructs an empty object. Telemed device has to be set after constructing by calling mitk::USTelemedProbesControls::SetTelemedDevice before the object can be used.

Definition at line 21 of file mitkUSTelemedProbesControls.cpp.

mitk::USTelemedProbesControls::~USTelemedProbesControls ( )
protectedvirtual

Definition at line 28 of file mitkUSTelemedProbesControls.cpp.

References SAFE_RELEASE.

Member Function Documentation

bool mitk::USTelemedProbesControls::CreateProbesCollection ( )
protected

Create collection object (Telemed API) for the API device.

Definition at line 138 of file mitkUSTelemedProbesControls.cpp.

References MITK_ERROR, MITK_WARN, mitkThrow, and SAFE_RELEASE.

void mitk::USTelemedProbesControls::CreateProbesSet ( )
protected

Create vector of mitk::USTelemedProbe objects from the Telemed API probe collection. Hence mitk::USTelemedProbesControls::CreateProbesCollection has to be called before.

Definition at line 175 of file mitkUSTelemedProbesControls.cpp.

References MITK_ERROR, mitkThrow, mitk::USProbe::New(), and SAFE_RELEASE.

bool mitk::USTelemedProbesControls::GetIsActive ( )
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

Implements mitk::USAbstractControlInterface.

Definition at line 54 of file mitkUSTelemedProbesControls.cpp.

unsigned int mitk::USTelemedProbesControls::GetProbesCount ( ) const
virtual
Returns
number of probes currently available at the ultrasound device

Implements mitk::USControlInterfaceProbes.

Definition at line 104 of file mitkUSTelemedProbesControls.cpp.

std::vector< mitk::USProbe::Pointer > mitk::USTelemedProbesControls::GetProbeSet ( )
virtual
Returns
vector of all probes currently available at the ultrasound device

Implements mitk::USControlInterfaceProbes.

Definition at line 59 of file mitkUSTelemedProbesControls.cpp.

mitk::USProbe::Pointer mitk::USTelemedProbesControls::GetSelectedProbe ( )
virtual
Returns
Ultrasound probe which is currently selected as the active probe.

Implements mitk::USControlInterfaceProbes.

Definition at line 90 of file mitkUSTelemedProbesControls.cpp.

References MITK_ERROR, and mitkThrow.

mitk::USTelemedProbesControls::mitkClassMacro ( USTelemedProbesControls  ,
USControlInterfaceProbes   
)
mitk::USTelemedProbesControls::mitkNewMacro1Param ( Self  ,
itk::SmartPointer< USTelemedDevice  
)
void mitk::USTelemedProbesControls::OnSelectProbe ( unsigned int  index)
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
indexindex of the probe to be selected

Implements mitk::USControlInterfaceProbes.

Definition at line 71 of file mitkUSTelemedProbesControls.cpp.

References MITK_ERROR, and mitkThrow.

virtual void mitk::USTelemedProbesControls::OnSelectProbe ( USProbe::Pointer  probe)
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
probepointer to probe to be selected

Implements mitk::USControlInterfaceProbes.

void mitk::USTelemedProbesControls::ProbeAdded ( unsigned int  index)

Definition at line 124 of file mitkUSTelemedProbesControls.cpp.

References MITK_INFO.

void mitk::USTelemedProbesControls::ProbeRemoved ( unsigned int  index)

Definition at line 114 of file mitkUSTelemedProbesControls.cpp.

References MITK_INFO.

void mitk::USTelemedProbesControls::SetIsActive ( bool  isActive)
virtual

Probe informations are fetched on activation. On deactivation there is nothing done.

Implements mitk::USAbstractControlInterface.

Definition at line 33 of file mitkUSTelemedProbesControls.cpp.

References MITK_WARN.

Member Data Documentation

bool mitk::USTelemedProbesControls::m_IsActive
protected

Definition at line 78 of file mitkUSTelemedProbesControls.h.

Usgfw2Lib::IProbe* mitk::USTelemedProbesControls::m_Probe
protected

Definition at line 84 of file mitkUSTelemedProbesControls.h.

Usgfw2Lib::IUsgCollection* mitk::USTelemedProbesControls::m_ProbesCollection
protected

Definition at line 83 of file mitkUSTelemedProbesControls.h.

std::vector<USTelemedProbe::Pointer> mitk::USTelemedProbesControls::m_ProbesSet
protected

Definition at line 80 of file mitkUSTelemedProbesControls.h.

unsigned int mitk::USTelemedProbesControls::m_SelectedProbeIndex
protected

Definition at line 79 of file mitkUSTelemedProbesControls.h.

itk::SmartPointer<USTelemedDevice> mitk::USTelemedProbesControls::m_TelemedDevice
protected

Definition at line 81 of file mitkUSTelemedProbesControls.h.


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