mitk::USTelemedProbe Class Reference

Specialized mitk::USProbe for handling Telemed API probe objects. It encapsulates a probe object from the Telemed API. More...

#include <mitkUSTelemedProbe.h>

Inheritance diagram for mitk::USTelemedProbe:

Collaboration diagram for mitk::USTelemedProbe:

Public Member Functions
	mitkClassMacro (USTelemedProbe, USProbe)
	mitkNewMacro2Param (Self, Usgfw2Lib::IProbe *, Usgfw2Lib::IUsgDataView *)
Usgfw2Lib::IProbe *	GetUsgProbe ()
Usgfw2Lib::IUsgDataView *	GetUsgDataView ()
Public Member Functions inherited from mitk::USProbe
	mitkClassMacroItkParent (USProbe, itk::Object)
Pointer	Clone () const
	mitkNewMacro1Param (Self, std::string)
bool	IsEqualToProbe (mitk::USProbe::Pointer probe)
	Compares this probe to another probe and returns true if they are equal in terms of name AND NAME ONLY be sure to sufficiently extend this method along with further capabilities probes. More...
void	SetDepthAndSpacing (int depth, Vector3D spacing)
	Sets a scanning depth of the probe and the associated spacing. More...
std::map< int, Vector3D >	GetDepthsAndSpacing ()
	Gets all scanning depths and the associates spacings of the probe as an std::map with depth as key (represented by an int) and spacing as value (represented by a Vector3D) More...
void	SetDepth (int depth)
	Sets a scanning depth of the probe with the default spacing (1,1,0). Exact spacing needs to be calibrated. More...
void	RemoveDepth (int depthToRemove)
	Removes the given depth of the probe, if it exists. More...
void	SetSpacingForGivenDepth (int givenDepth, Vector3D spacing)
Vector3D	GetSpacingForGivenDepth (int givenDepth)
	Returns the spacing that is associated to the given depth of the probe. If spacing was not calibrated or if depth does not exist for this probe the default spacing (1,1,0) is returned. More...
virtual std::string	GetName ()
virtual void	SetName (std::string _arg)

Protected Member Functions
	USTelemedProbe (Usgfw2Lib::IProbe *probe, Usgfw2Lib::IUsgDataView *dataView)
virtual	~USTelemedProbe ()
Protected Member Functions inherited from mitk::USProbe
	USProbe ()
	USProbe (std::string identifier)
virtual	~USProbe ()

Protected Attributes
Usgfw2Lib::IProbe *	m_UsgProbe
Usgfw2Lib::IUsgDataView *	m_UsgDataView
Protected Attributes inherited from mitk::USProbe
std::string	m_Name
std::map< int, Vector3D >	m_DepthsAndSpacings

Additional Inherited Members
Static Public Member Functions inherited from mitk::USProbe
static Pointer	New ()

Detailed Description

Specialized mitk::USProbe for handling Telemed API probe objects. It encapsulates a probe object from the Telemed API.

This class should only be instantiated by mitk::USTelemedProbesControls. Every other object can get instances of mitk::USTelemedProbe from there.

Definition at line 36 of file mitkUSTelemedProbe.h.

Constructor & Destructor Documentation

mitk::USTelemedProbe::USTelemedProbe ( Usgfw2Lib::IProbe *  probe, Usgfw2Lib::IUsgDataView *  dataView  )

protected

Constructs mitk::USTelemedProbe object with given API objects.

Parameters

probe	API probe object which should be represented by the constructed object
dataView	API data view object conected to this probe object

Definition at line 20 of file mitkUSTelemedProbe.cpp.

References mitk::telemed::ConvertWcharToString(), and mitk::USProbe::SetName().

mitk::USTelemedProbe::~USTelemedProbe ( )

protectedvirtual

Definition at line 28 of file mitkUSTelemedProbe.cpp.

References SAFE_RELEASE.

Member Function Documentation

Usgfw2Lib::IUsgDataView * mitk::USTelemedProbe::GetUsgDataView

(

)

Returns the Telemed API data view connected with this object. This method is just for being called by mitk::USTelemedProbesControls.

Definition at line 39 of file mitkUSTelemedProbe.cpp.

Usgfw2Lib::IProbe * mitk::USTelemedProbe::GetUsgProbe

(

)

Returns the Telemed API probe connected with this object. This method is just for being called by mitk::USTelemedProbesControls.

Definition at line 34 of file mitkUSTelemedProbe.cpp.

mitk::USTelemedProbe::mitkClassMacro	(	USTelemedProbe	,
		USProbe
	)

mitk::USTelemedProbe::mitkNewMacro2Param	(	Self	,
		Usgfw2Lib::IProbe *	,
		Usgfw2Lib::IUsgDataView *
	)

Member Data Documentation

Usgfw2Lib::IUsgDataView* mitk::USTelemedProbe::m_UsgDataView

protected

Definition at line 65 of file mitkUSTelemedProbe.h.

Usgfw2Lib::IProbe* mitk::USTelemedProbe::m_UsgProbe

protected

Definition at line 64 of file mitkUSTelemedProbe.h.

---

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

• mitkUSTelemedProbe.h
• mitkUSTelemedProbe.cpp