Implementation of mitk::USDevice for Telemed API devices. Connects to a Telemed API device through its COM library interface. More...

#include <mitkUSTelemedDevice.h>

Inheritance diagram for mitk::USTelemedDevice:

[legend]

Collaboration diagram for mitk::USTelemedDevice:

[legend]

Public Member Functions
	mitkClassMacro (USTelemedDevice, mitk::USDevice)

	mitkNewMacro2Param (Self, std::string, std::string)

virtual std::string	GetDeviceClass ()
	Returns the class of the device. More...

virtual USControlInterfaceBMode::Pointer	GetControlInterfaceBMode ()
	Default getter for the b mode control interface. Has to be implemented in a subclass if a b mode control interface is available. Default implementation returns null. More...

virtual USControlInterfaceProbes::Pointer	GetControlInterfaceProbes ()
	Default getter for the probes control interface. Has to be implemented in a subclass if a probes control interface is available. Default implementation returns null. More...

virtual USControlInterfaceDoppler::Pointer	GetControlInterfaceDoppler ()
	Default getter for the doppler control interface. Has to be implemented in a subclass if a doppler control interface is available. Default implementation returns null. More...

virtual bool	OnInitialization ()
	Is called during the initialization process. There is nothing done on the initialization of a mik::USTelemedDevive object. More...

virtual bool	OnConnection ()
	Is called during the connection process. Connect to the Telemed API and try to get available probes from the device. More...

virtual bool	OnDisconnection ()
	Is called during the disconnection process. Deactivate and remove all Telemed API controls. A disconnect from the Telemed API is not possible for which reason the hardware stays in connected state even after calling this method. More...

virtual bool	OnActivation ()
	Is called during the activation process. After this method is finished, the device is generating images in b mode. Changing scanning mode is possible afterwards by using the appropriate control interfaces. More...

virtual bool	OnDeactivation ()
	Is called during the deactivation process. After a call to this method the device is connected, but not producing images anymore. More...

virtual void	OnFreeze (bool freeze)
	Changes scan state of the device if freeze is toggeled in mitk::USDevice. More...

USImageSource::Pointer	GetUSImageSource ()

Usgfw2Lib::IUsgfw2 *	GetUsgMainInterface ()
	Getter for main Telemed API object. This method is for being called by Telemed control interfaces. More...

void	SetActiveDataView (Usgfw2Lib::IUsgDataView *)
	Changes active IUsgDataView of the device. This method is for being called by Telemed control interfaces. More...

virtual HRESULT __stdcall	raw_OnProbeArrive (IUnknown pUsgProbe, ULONG reserved)

virtual HRESULT __stdcall	raw_OnBeamformerArrive (IUnknown pUsgBeamformer, ULONG reserved)

virtual HRESULT __stdcall	raw_OnProbeRemove (IUnknown pUsgProbe, ULONG reserved)

virtual HRESULT __stdcall	raw_OnBeamformerRemove (IUnknown pUsgBeamformer, ULONG reserved)

virtual HRESULT __stdcall	raw_OnProbeStateChanged (IUnknown pUsgProbe, ULONG reserved)

virtual HRESULT __stdcall	raw_OnBeamformerStateChanged (IUnknown pUsgBeamformer, ULONG reserved)

	STDMETHODIMP_ (ULONG) AddRef()

	STDMETHODIMP_ (ULONG) Release()

STDMETHODIMP	QueryInterface (REFIID riid, void **ppv)

virtual HRESULT STDMETHODCALLTYPE	GetTypeInfoCount (UINT *pctinfo)

virtual HRESULT STDMETHODCALLTYPE	GetTypeInfo (UINT itinfo, LCID lcid, ITypeInfo **pptinfo)

virtual HRESULT STDMETHODCALLTYPE	GetIDsOfNames (const IID &riid, LPOLESTR rgszNames, UINT cNames, LCID lcid, DISPID rgdispid)

virtual HRESULT STDMETHODCALLTYPE	Invoke (DISPID dispIdMember, const IID &riid, LCID lcid, WORD wFlags, DISPPARAMS pDispParams, VARIANT pVarResult, EXCEPINFO pExcepInfo, UINT puArgErr)

Public Member Functions inherited from mitk::USDevice
	mitkClassMacro (USDevice, mitk::ImageSource)

virtual void	SetSpawnAcquireThread (bool _arg)

virtual bool	GetSpawnAcquireThread ()

	mitkNewMessage2Macro (PropertyChanged, const std::string &, const std::string &)
	Event for being notified about changes of the micro service properties. This event can be used if no micro service context is available. More...

virtual itk::SmartPointer< USAbstractControlInterface >	GetControlInterfaceCustom ()
	Default getter for the custom control interface. Has to be implemented in a subclass if a custom control interface is available. Default implementation returns null. More...

bool	Initialize ()
	Changes device state to mitk::USDevice::State_Initialized. During initialization the virtual method mitk::USDevice::OnInitialization will be called. If this method returns false the initialization process will be canceled. Otherwise the mitk::USDevice is registered in a micro service. More...

bool	Connect ()
	Connects this device. A connected device is ready to deliver images (i.e. be Activated). A Connected Device can be active. A disconnected Device cannot be active. Internally calls onConnect and then registers the device with the service. A device usually should override the OnConnection() method, but never the Connect() method, since this will possibly exclude the device from normal service management. The exact flow of events is: 0. Check if the device is already connected. If yes, return true anyway, but don't do anything. More...

void	ConnectAsynchron ()

bool	Disconnect ()
	Works analogously to mitk::USDevice::Connect(). Don't override this Method, but onDisconnection instead. More...

bool	Activate ()
	Activates this device. After the activation process, the device will start to produce images. This Method will fail, if the device is not connected. More...

void	Deactivate ()
	Deactivates this device. After the deactivation process, the device will no longer produce images, but still be connected. More...

virtual void	SetIsFreezed (bool freeze)
	Can toggle if ultrasound image is currently updated or freezed. More...

virtual bool	GetIsFreezed ()

void	PushFilter (AbstractOpenCVImageFilter::Pointer filter)

void	PushFilterIfNotPushedBefore (AbstractOpenCVImageFilter::Pointer filter)

bool	RemoveFilter (AbstractOpenCVImageFilter::Pointer filter)

void	ProbeChanged (std::string probename)
	To be called when the used probe changed. Will update the service properties. More...

void	DepthChanged (double depth)
	To be called when the scanning depth of the probe changed. Will update the service properties. More...

void	UpdateServiceProperty (std::string key, std::string value)
	Given property is updated in the device micro service. This method is mainly for being used by the control interface superclasses. You do not need to call it by yoursefs in your concrete control interface classes. More...

void	UpdateServiceProperty (std::string key, double value)

void	UpdateServiceProperty (std::string key, bool value)

bool	GetIsInitialized ()
	True, if the device object is created and initialized, false otherwise. More...

bool	GetIsActive ()
	True, if the device is currently generating image data, false otherwise. More...

bool	GetIsConnected ()
	True, if the device is currently ready to start transmitting image data or is already transmitting image data. A disconnected device cannot be activated. More...

mitk::USDevice::USImageCropArea	GetCropArea ()

unsigned int	GetSizeOfImageVector ()

std::string	GetDeviceManufacturer ()
	Deprecated -> use GetManufacturer() instead. More...

std::string	GetDeviceModel ()
	Deprecated -> use GetName() instead. More...

std::string	GetDeviceComment ()
	Deprecated -> use GetCommend() instead. More...

virtual std::string	GetManufacturer ()

virtual std::string	GetName ()

virtual std::string	GetComment ()

void	SetManufacturer (std::string manufacturer)

void	SetName (std::string name)

void	SetComment (std::string comment)

virtual DeviceStates	GetDeviceState ()

virtual us::ServiceProperties	GetServiceProperties ()

void	GrabImage ()

virtual std::vector< mitk::USProbe::Pointer >	GetAllProbes ()=0
	Returns all probes for this device or an empty vector it no probes were set Returns a std::vector of all probes that exist for this device if there were probes set while creating or modifying this USVideoDevice. Otherwise it returns an empty vector. Therefore always check if vector is filled, before using it! More...

virtual void	DeleteAllProbes ()
	Cleans the std::vector containing all configured probes. More...

virtual mitk::USProbe::Pointer	GetCurrentProbe ()=0
	Return current active probe for this USDevice Returns a pointer to the probe that is currently in use. If there were probes set while creating or modifying this USDevice. Returns null otherwise. More...

virtual void	AddNewProbe (mitk::USProbe::Pointer)
	adds a new probe to the device More...

virtual mitk::USProbe::Pointer	GetProbeByName (std::string name)=0
	get the probe by its name Returns a pointer to the probe identified by the given name. If no probe of given name exists for this Device 0 is returned. More...

virtual void	RemoveProbeByName (std::string)
	Removes the Probe with the given name. More...

virtual void	SetDefaultProbeAsCurrentProbe ()
	Sets the first existing probe or the default probe of the ultrasound device as the current probe of it. More...

virtual void	SetCurrentProbe (std::string)
	Sets the probe with the given name as current probe if the named probe exists. More...

virtual void	SetSpacing (double xSpacing, double ySpacing)

Public Member Functions inherited from mitk::ImageSource
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

Pointer	Clone () const

OutputType *	GetOutput ()
	Get the output data of this image source object. More...

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Make a DataObject of the correct type to used as the specified output. More...

itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual vtkImageData *	GetVtkImageData ()

virtual const vtkImageData *	GetVtkImageData () const

Public Member Functions inherited from mitk::BaseDataSource
OutputType *	GetOutput ()

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

virtual void	GraftOutput (OutputType *output)
	Graft the specified BaseData onto this BaseDataSource's output. More...

virtual void	GraftOutput (const DataObjectIdentifierType &key, OutputType *output)

virtual void	GraftNthOutput (unsigned int idx, OutputType *output)
	Graft the specified base data object onto this BaseDataSource's idx'th output. More...

bool	Updating () const
	Access itk::ProcessObject::m_Updating. More...

Protected Member Functions
	USTelemedDevice (std::string manufacturer, std::string model)

virtual	~USTelemedDevice ()

void	ReleaseUsgControls ()

void	ConnectDeviceChangeSink ()

void	StopScanning ()
	Stop ultrasound scanning by Telemed API call. More...

Protected Member Functions inherited from mitk::USDevice
virtual void	SetImageVector (std::vector< mitk::Image::Pointer > vec)

void	ProvideViaOIGTL ()
	Registers an OpenIGTLink device as a microservice so that we can send the images of this device via the network. More...

void	DisableOIGTL ()
	Deregisters the microservices for OpenIGTLink. More...

us::ServiceProperties	ConstructServiceProperties ()
	This Method constructs the service properties which can later be used to register the object with the Microservices Return service properties. More...

void	UnregisterOnService ()
	Remove this device from the micro service. More...

	USDevice (std::string manufacturer, std::string model)
	Enforces minimal Metadata to be set. More...

	USDevice (mitk::USImageMetadata::Pointer metadata)
	Constructs a device with the given Metadata. Make sure the Metadata contains meaningful content! More...

	~USDevice () override

void	GenerateData () override
	Grabs the next frame from the Video input. This method is called internally, whenever Update() is invoked by an Output. More...

std::string	GetServicePropertyLabel ()

Protected Member Functions inherited from mitk::ImageSource
	ImageSource ()

	~ImageSource () override

void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
	If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...

void	PrepareOutputs () override
	This method is intentionally left blank. More...

virtual void	AllocateOutputs ()
	The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...

virtual void	BeforeThreadedGenerateData ()
	If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...

virtual void	AfterThreadedGenerateData ()
	If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
	Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...

Protected Member Functions inherited from mitk::BaseDataSource
	BaseDataSource ()

	~BaseDataSource () override

Protected Attributes
USTelemedProbesControls::Pointer	m_ControlsProbes

USTelemedBModeControls::Pointer	m_ControlsBMode

USTelemedDopplerControls::Pointer	m_ControlsDoppler

USTelemedImageSource::Pointer	m_ImageSource

Usgfw2Lib::IUsgfw2 *	m_UsgMainInterface

Usgfw2Lib::IProbe *	m_Probe

Usgfw2Lib::IUsgDataView *	m_UsgDataView

Usgfw2Lib::IUsgCollection *	m_ProbesCollection

ULONG	m_RefCount

IConnectionPoint *	m_UsgDeviceChangeCpnt

DWORD	m_UsgDeviceChangeCpntCookie

Protected Attributes inherited from mitk::USDevice
itk::ConditionVariable::Pointer	m_FreezeBarrier

itk::SimpleMutexLock	m_FreezeMutex

itk::MultiThreader::Pointer	m_MultiThreader
	itk::MultiThreader used for thread handling More...

itk::FastMutexLock::Pointer	m_ImageMutex
	mutex for images provided by the image source More...

int	m_ThreadID
	ID of the started thread. More...

std::vector< mitk::Image::Pointer >	m_ImageVector

mitk::Vector3D	m_Spacing

mitk::IGTLServer::Pointer	m_IGTLServer

mitk::IGTLMessageProvider::Pointer	m_IGTLMessageProvider

mitk::ImageToIGTLMessageFilter::Pointer	m_ImageToIGTLMsgFilter

bool	m_IsFreezed

DeviceStates	m_DeviceState

USImageCropArea	m_CropArea

unsigned int	m_NumberOfOutputs

us::ServiceProperties	m_ServiceProperties
	Properties of the device's Microservice. More...

us::ServiceRegistration< Self >	m_ServiceRegistration
	The device's ServiceRegistration object that allows to modify it's Microservice registraton details. More...

Additional Inherited Members
Public Types inherited from mitk::USDevice
enum	DeviceStates { State_NoState, State_Initialized, State_Connected, State_Activated }

Public Types inherited from mitk::ImageSource
typedef ImageSource	Self

typedef BaseDataSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef mitk::Image	OutputImageType
	Some convenient typedefs. More...

typedef OutputImageType	OutputType

typedef OutputImageType::Pointer	OutputImagePointer

typedef SlicedData::RegionType	OutputImageRegionType

Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource	Self

typedef itk::ProcessObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef BaseData	OutputType

typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType

Static Public Member Functions inherited from mitk::USDevice
static mitk::USDevice::PropertyKeys	GetPropertyKeys ()

Static Public Member Functions inherited from mitk::ImageSource
static const char *	GetStaticNameOfClass ()

static Pointer	New ()
	Method for creation through the object factory. More...

Static Public Member Functions inherited from mitk::BaseDataSource
static const char *	GetStaticNameOfClass ()

Static Protected Member Functions inherited from mitk::USDevice
static ITK_THREAD_RETURN_TYPE	Acquire (void *pInfoStruct)

static ITK_THREAD_RETURN_TYPE	ConnectThread (void *pInfoStruct)

Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
	Static function used as a "callback" by the MultiThreader. More...

Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer	New ()

Detailed Description

Implementation of mitk::USDevice for Telemed API devices. Connects to a Telemed API device through its COM library interface.

This class handles all API communications and creates interfaces for b mode, doppler and probes controls. Images given by the device are put into an object of mitk::USTelemedImageSource.

It implements IUsgDeviceChangeSink of the Telemed API to be notified of changes to beamformer device or probes (e.g. probe change).

Definition at line 38 of file mitkUSTelemedDevice.h.

Constructor & Destructor Documentation

◆ USTelemedDevice()

mitk::USTelemedDevice::USTelemedDevice	(	std::string	manufacturer,
		std::string	model
	)

protected

Constructs a mitk::USTelemedDevice object by given manufacturer and model string. These strings are just for labeling the device in the micro service.

Control interfaces and image source are available directly after construction. Registration at the micro service happens not before initialization method was called.

Definition at line 17 of file mitkUSTelemedDevice.cpp.

References mitk::ImageSource::MakeOutput().

Referenced by raw_OnBeamformerStateChanged().

◆ ~USTelemedDevice()

mitk::USTelemedDevice::~USTelemedDevice ( )

protectedvirtual

Definition at line 29 of file mitkUSTelemedDevice.cpp.

Referenced by raw_OnBeamformerStateChanged().

Member Function Documentation

◆ ConnectDeviceChangeSink()

void mitk::USTelemedDevice::ConnectDeviceChangeSink ( )

protected

Definition at line 197 of file mitkUSTelemedDevice.cpp.

References m_UsgDeviceChangeCpnt, m_UsgDeviceChangeCpntCookie, m_UsgMainInterface, and SAFE_RELEASE.

Referenced by OnConnection(), and raw_OnBeamformerStateChanged().

◆ GetControlInterfaceBMode()

mitk::USControlInterfaceBMode::Pointer mitk::USTelemedDevice::GetControlInterfaceBMode ( )

virtual

Default getter for the b mode control interface. Has to be implemented in a subclass if a b mode control interface is available. Default implementation returns null.

Returns: null pointer

Reimplemented from mitk::USDevice.

Definition at line 38 of file mitkUSTelemedDevice.cpp.

References m_ControlsBMode.

◆ GetControlInterfaceDoppler()

mitk::USControlInterfaceDoppler::Pointer mitk::USTelemedDevice::GetControlInterfaceDoppler ( )

virtual

Default getter for the doppler control interface. Has to be implemented in a subclass if a doppler control interface is available. Default implementation returns null.

Returns: null pointer

Reimplemented from mitk::USDevice.

Definition at line 48 of file mitkUSTelemedDevice.cpp.

References m_ControlsDoppler.

◆ GetControlInterfaceProbes()

mitk::USControlInterfaceProbes::Pointer mitk::USTelemedDevice::GetControlInterfaceProbes ( )

virtual

Default getter for the probes control interface. Has to be implemented in a subclass if a probes control interface is available. Default implementation returns null.

Returns: null pointer

Reimplemented from mitk::USDevice.

Definition at line 43 of file mitkUSTelemedDevice.cpp.

References m_ControlsProbes.

◆ GetDeviceClass()

std::string mitk::USTelemedDevice::GetDeviceClass ( )

virtual

Returns the class of the device.

Implements mitk::USDevice.

Definition at line 33 of file mitkUSTelemedDevice.cpp.

◆ GetIDsOfNames()

HRESULT mitk::USTelemedDevice::GetIDsOfNames	(	const IID &	riid,
		LPOLESTR *	rgszNames,
		UINT	cNames,
		LCID	lcid,
		DISPID *	rgdispid
	)

virtual

Definition at line 296 of file mitkUSTelemedDevice.cpp.

Referenced by raw_OnBeamformerStateChanged().

◆ GetTypeInfo()

HRESULT mitk::USTelemedDevice::GetTypeInfo	(	UINT	itinfo,
		LCID	lcid,
		ITypeInfo **	pptinfo
	)

virtual

Definition at line 288 of file mitkUSTelemedDevice.cpp.

Referenced by raw_OnBeamformerStateChanged().

◆ GetTypeInfoCount()

HRESULT mitk::USTelemedDevice::GetTypeInfoCount ( UINT * pctinfo )

virtual

Definition at line 281 of file mitkUSTelemedDevice.cpp.

Referenced by raw_OnBeamformerStateChanged().

◆ GetUsgMainInterface()

Usgfw2Lib::IUsgfw2 * mitk::USTelemedDevice::GetUsgMainInterface ( )

Getter for main Telemed API object. This method is for being called by Telemed control interfaces.

Definition at line 177 of file mitkUSTelemedDevice.cpp.

References m_UsgMainInterface.

◆ GetUSImageSource()

mitk::USImageSource::Pointer mitk::USTelemedDevice::GetUSImageSource ( )

virtual

Returns: Returns the current image source of this device.

Implements mitk::USDevice.

Definition at line 144 of file mitkUSTelemedDevice.cpp.

References m_ImageSource.

◆ Invoke()

HRESULT mitk::USTelemedDevice::Invoke	(	DISPID	dispIdMember,
		const IID &	riid,
		LCID	lcid,
		WORD	wFlags,
		DISPPARAMS *	pDispParams,
		VARIANT *	pVarResult,
		EXCEPINFO *	pExcepInfo,
		UINT *	puArgErr
	)

virtual

Definition at line 302 of file mitkUSTelemedDevice.cpp.

Referenced by raw_OnBeamformerStateChanged().

◆ mitkClassMacro()

mitk::USTelemedDevice::mitkClassMacro	(	USTelemedDevice	,
		mitk::USDevice
	)

◆ mitkNewMacro2Param()

mitk::USTelemedDevice::mitkNewMacro2Param	(	Self	,
		std::string	,
		std::string
	)

◆ OnActivation()

bool mitk::USTelemedDevice::OnActivation ( )

virtual

Is called during the activation process. After this method is finished, the device is generating images in b mode. Changing scanning mode is possible afterwards by using the appropriate control interfaces.

Returns: always true

Exceptions

mitk::Exception if something goes wrong at the API calls

Implements mitk::USDevice.

Definition at line 90 of file mitkUSTelemedDevice.cpp.

References m_ControlsBMode, m_ControlsProbes, m_UsgDataView, MITK_ERROR, and MITK_WARN.

◆ OnConnection()

bool mitk::USTelemedDevice::OnConnection ( )

virtual

Is called during the connection process. Connect to the Telemed API and try to get available probes from the device.

Returns: true if successfull, false if no device is connected to the pc

Exceptions

mitk::Exception if something goes wrong at the API calls

Implements mitk::USDevice.

Definition at line 60 of file mitkUSTelemedDevice.cpp.

References ConnectDeviceChangeSink(), m_UsgMainInterface, MITK_ERROR, and SAFE_RELEASE.

◆ OnDeactivation()

bool mitk::USTelemedDevice::OnDeactivation ( )

virtual

Is called during the deactivation process. After a call to this method the device is connected, but not producing images anymore.

Returns: always true

Exceptions

mitk::Exception if something goes wrong at the API calls

Implements mitk::USDevice.

Definition at line 126 of file mitkUSTelemedDevice.cpp.

References StopScanning().

◆ OnDisconnection()

bool mitk::USTelemedDevice::OnDisconnection ( )

virtual

Is called during the disconnection process. Deactivate and remove all Telemed API controls. A disconnect from the Telemed API is not possible for which reason the hardware stays in connected state even after calling this method.

Returns: always true

Exceptions

mitk::Exception if something goes wrong at the API calls

Implements mitk::USDevice.

Definition at line 78 of file mitkUSTelemedDevice.cpp.

References m_ControlsBMode, m_ControlsDoppler, m_ControlsProbes, and ReleaseUsgControls().

◆ OnFreeze()

void mitk::USTelemedDevice::OnFreeze ( bool freeze )

virtual

Changes scan state of the device if freeze is toggeled in mitk::USDevice.

Reimplemented from mitk::USDevice.

Definition at line 132 of file mitkUSTelemedDevice.cpp.

References m_UsgDataView.

◆ OnInitialization()

bool mitk::USTelemedDevice::OnInitialization ( )

virtual

Is called during the initialization process. There is nothing done on the initialization of a mik::USTelemedDevive object.

Returns: always true

Implements mitk::USDevice.

Definition at line 53 of file mitkUSTelemedDevice.cpp.

◆ QueryInterface()

STDMETHODIMP mitk::USTelemedDevice::QueryInterface	(	REFIID	riid,
		void **	ppv
	)

Definition at line 266 of file mitkUSTelemedDevice.cpp.

Referenced by raw_OnBeamformerStateChanged().

◆ raw_OnBeamformerArrive()

HRESULT __stdcall mitk::USTelemedDevice::raw_OnBeamformerArrive	(	IUnknown *	pUsgBeamformer,
		ULONG *	reserved
	)

virtual

Definition at line 220 of file mitkUSTelemedDevice.cpp.

References mitk::USDevice::Connect().

◆ raw_OnBeamformerRemove()

HRESULT __stdcall mitk::USTelemedDevice::raw_OnBeamformerRemove	(	IUnknown *	pUsgBeamformer,
		ULONG *	reserved
	)

virtual

Definition at line 227 of file mitkUSTelemedDevice.cpp.

References mitk::USDevice::Deactivate(), mitk::USDevice::Disconnect(), and mitk::USDevice::GetIsActive().

◆ raw_OnBeamformerStateChanged()

virtual HRESULT __stdcall mitk::USTelemedDevice::raw_OnBeamformerStateChanged	(	IUnknown *	pUsgBeamformer,
		ULONG *	reserved
	)

inlinevirtual

Definition at line 127 of file mitkUSTelemedDevice.h.

References ConnectDeviceChangeSink(), GetIDsOfNames(), GetTypeInfo(), GetTypeInfoCount(), Invoke(), QueryInterface(), ReleaseUsgControls(), STDMETHODIMP_(), StopScanning(), USTelemedDevice(), and ~USTelemedDevice().

◆ raw_OnProbeArrive()

HRESULT __stdcall mitk::USTelemedDevice::raw_OnProbeArrive	(	IUnknown *	pUsgProbe,
		ULONG *	reserved
	)

virtual

Definition at line 236 of file mitkUSTelemedDevice.cpp.

References mitk::USDevice::Activate(), and m_ControlsProbes.

◆ raw_OnProbeRemove()

HRESULT __stdcall mitk::USTelemedDevice::raw_OnProbeRemove	(	IUnknown *	pUsgProbe,
		ULONG *	reserved
	)

virtual

Definition at line 245 of file mitkUSTelemedDevice.cpp.

References mitk::USDevice::Deactivate(), mitk::USDevice::GetIsActive(), and m_ControlsProbes.

◆ raw_OnProbeStateChanged()

virtual HRESULT __stdcall mitk::USTelemedDevice::raw_OnProbeStateChanged	(	IUnknown *	pUsgProbe,
		ULONG *	reserved
	)

inlinevirtual

Definition at line 126 of file mitkUSTelemedDevice.h.

◆ ReleaseUsgControls()

void mitk::USTelemedDevice::ReleaseUsgControls ( )

protected

Definition at line 149 of file mitkUSTelemedDevice.cpp.

References m_Probe, m_ProbesCollection, m_UsgDataView, m_UsgMainInterface, SAFE_RELEASE, and StopScanning().

Referenced by OnDisconnection(), and raw_OnBeamformerStateChanged().

◆ SetActiveDataView()

void mitk::USTelemedDevice::SetActiveDataView ( Usgfw2Lib::IUsgDataView * usgDataView )

Changes active IUsgDataView of the device. This method is for being called by Telemed control interfaces.

Definition at line 182 of file mitkUSTelemedDevice.cpp.

References m_ControlsBMode, m_ImageSource, and m_UsgDataView.

◆ STDMETHODIMP_() [1/2]

mitk::USTelemedDevice::STDMETHODIMP_ ( ULONG )

Referenced by raw_OnBeamformerStateChanged(), and STDMETHODIMP_().

◆ STDMETHODIMP_() [2/2]

mitk::USTelemedDevice::STDMETHODIMP_ ( ULONG )

◆ StopScanning()

void mitk::USTelemedDevice::StopScanning ( )

protected

Stop ultrasound scanning by Telemed API call.

Exceptions

mitk::Exception if API call returned with an error

Definition at line 159 of file mitkUSTelemedDevice.cpp.

References m_UsgDataView, MITK_ERROR, MITK_WARN, and mitkThrow.

Referenced by OnDeactivation(), raw_OnBeamformerStateChanged(), and ReleaseUsgControls().

Member Data Documentation

◆ m_ControlsBMode

USTelemedBModeControls::Pointer mitk::USTelemedDevice::m_ControlsBMode

protected

Definition at line 165 of file mitkUSTelemedDevice.h.

Referenced by GetControlInterfaceBMode(), OnActivation(), OnDisconnection(), and SetActiveDataView().

◆ m_ControlsDoppler

USTelemedDopplerControls::Pointer mitk::USTelemedDevice::m_ControlsDoppler

protected

Definition at line 166 of file mitkUSTelemedDevice.h.

Referenced by GetControlInterfaceDoppler(), and OnDisconnection().

◆ m_ControlsProbes

USTelemedProbesControls::Pointer mitk::USTelemedDevice::m_ControlsProbes

protected

Definition at line 164 of file mitkUSTelemedDevice.h.

Referenced by GetControlInterfaceProbes(), OnActivation(), OnDisconnection(), raw_OnProbeArrive(), and raw_OnProbeRemove().

◆ m_ImageSource

USTelemedImageSource::Pointer mitk::USTelemedDevice::m_ImageSource

protected

Definition at line 168 of file mitkUSTelemedDevice.h.

Referenced by GetUSImageSource(), and SetActiveDataView().

◆ m_Probe

Usgfw2Lib::IProbe* mitk::USTelemedDevice::m_Probe

protected

Definition at line 171 of file mitkUSTelemedDevice.h.

Referenced by ReleaseUsgControls().

◆ m_ProbesCollection

Usgfw2Lib::IUsgCollection* mitk::USTelemedDevice::m_ProbesCollection

protected

Definition at line 173 of file mitkUSTelemedDevice.h.

Referenced by ReleaseUsgControls().

◆ m_RefCount

ULONG mitk::USTelemedDevice::m_RefCount

protected

Definition at line 175 of file mitkUSTelemedDevice.h.

Referenced by STDMETHODIMP_().

◆ m_UsgDataView

Usgfw2Lib::IUsgDataView* mitk::USTelemedDevice::m_UsgDataView

protected

Definition at line 172 of file mitkUSTelemedDevice.h.

Referenced by OnActivation(), OnFreeze(), ReleaseUsgControls(), SetActiveDataView(), and StopScanning().

◆ m_UsgDeviceChangeCpnt

IConnectionPoint* mitk::USTelemedDevice::m_UsgDeviceChangeCpnt

protected

Definition at line 176 of file mitkUSTelemedDevice.h.

Referenced by ConnectDeviceChangeSink().

◆ m_UsgDeviceChangeCpntCookie

DWORD mitk::USTelemedDevice::m_UsgDeviceChangeCpntCookie

protected

Definition at line 177 of file mitkUSTelemedDevice.h.

Referenced by ConnectDeviceChangeSink().

◆ m_UsgMainInterface

Usgfw2Lib::IUsgfw2* mitk::USTelemedDevice::m_UsgMainInterface

protected

Definition at line 170 of file mitkUSTelemedDevice.h.

Referenced by ConnectDeviceChangeSink(), GetUsgMainInterface(), OnConnection(), and ReleaseUsgControls().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ USTelemedDevice()

◆ ~USTelemedDevice()

Member Function Documentation

◆ ConnectDeviceChangeSink()

◆ GetControlInterfaceBMode()

◆ GetControlInterfaceDoppler()

◆ GetControlInterfaceProbes()

◆ GetDeviceClass()

◆ GetIDsOfNames()

◆ GetTypeInfo()

◆ GetTypeInfoCount()

◆ GetUsgMainInterface()

◆ GetUSImageSource()

◆ Invoke()

◆ mitkClassMacro()

◆ mitkNewMacro2Param()

◆ OnActivation()

◆ OnConnection()

◆ OnDeactivation()

◆ OnDisconnection()

◆ OnFreeze()

◆ OnInitialization()

◆ QueryInterface()

◆ raw_OnBeamformerArrive()

◆ raw_OnBeamformerRemove()

◆ raw_OnBeamformerStateChanged()

◆ raw_OnProbeArrive()

◆ raw_OnProbeRemove()

◆ raw_OnProbeStateChanged()

◆ ReleaseUsgControls()

◆ SetActiveDataView()

◆ STDMETHODIMP_() [1/2]

◆ STDMETHODIMP_() [2/2]

◆ StopScanning()

Member Data Documentation

◆ m_ControlsBMode

◆ m_ControlsDoppler

◆ m_ControlsProbes

◆ m_ImageSource

◆ m_Probe

◆ m_ProbesCollection

◆ m_RefCount

◆ m_UsgDataView

◆ m_UsgDeviceChangeCpnt

◆ m_UsgDeviceChangeCpntCookie

◆ m_UsgMainInterface