mitkUSTelemedSDKHeader.h File Reference

#include <Usgfw2.tlh>
#include <mitkCommon.h>

Go to the source code of this file.

Namespaces
	mitk
	DataCollection - Class to facilitate loading/accessing structured data.
	mitk::telemed

Macros
#define	SAFE_RELEASE(x)
#define	RETURN_TelemedValue(control)
#define	SET_TelemedValue(control, value)
#define	RETURN_TelemedAvailableValues(control)
#define	RETURN_TelemedAvailableValuesWithFactor(control, factor)
#define	GETINOUTPUT_TelemedAvailableValuesBounds(control, output)
#define	CREATE_TelemedControl(control, dataView, iidType, type, scanMode)

Enumerations
enum	mitk::telemed::ScanModes { mitk::telemed::ScanModeB }

Functions
bool	mitk::telemed::CreateUsgControl (Usgfw2Lib::IUsgDataView *dataView, const IID &typeId, ULONG scanMode, ULONG streamId, void **ctrl)
std::string	mitk::telemed::ConvertWcharToString (const BSTR input)

Macro Definition Documentation

CREATE_TelemedControl

#define CREATE_TelemedControl	(		control,
			dataView,
			iidType,
			type,
			scanMode
	)

Create Telemed API control. The interface documentation can be found in the Telemed API documentation regarding CreateUsgControl().

Definition at line 109 of file mitkUSTelemedSDKHeader.h.

Referenced by mitk::USTelemedImageSource::CreateAndConnectConverterPlugin(), and mitk::USTelemedBModeControls::CreateControls().

GETINOUTPUT_TelemedAvailableValuesBounds

#define GETINOUTPUT_TelemedAvailableValuesBounds	(		control,
			output
	)

Get all available values for given COM object, calculate minimum, maximum and interval step from them and save this three in given "output" variable. This variable must be a c array with three elements.

Definition at line 83 of file mitkUSTelemedSDKHeader.h.

Referenced by mitk::USTelemedBModeControls::CreateControls().

RETURN_TelemedAvailableValues

#define RETURN_TelemedAvailableValues

(

control

)

Get all available values for given COM object and return them as std::vector<double>.

Definition at line 52 of file mitkUSTelemedSDKHeader.h.

Referenced by mitk::USTelemedBModeControls::GetScanningDepthValues().

RETURN_TelemedAvailableValuesWithFactor

#define RETURN_TelemedAvailableValuesWithFactor	(		control,
			factor
	)

Definition at line 56 of file mitkUSTelemedSDKHeader.h.

Referenced by mitk::USTelemedBModeControls::GetScanningFrequencyValues().

RETURN_TelemedValue

#define RETURN_TelemedValue

(

control

)

Get the current value from the given COM object and return it as double.

Definition at line 33 of file mitkUSTelemedSDKHeader.h.

Referenced by mitk::USTelemedBModeControls::GetScanningDepth(), mitk::USTelemedBModeControls::GetScanningDynamicRange(), mitk::USTelemedBModeControls::GetScanningFrequencyAPI(), mitk::USTelemedBModeControls::GetScanningGain(), mitk::USTelemedBModeControls::GetScanningPower(), and mitk::USTelemedBModeControls::GetScanningRejection().

SAFE_RELEASE

#define SAFE_RELEASE

(

x

)

Release the given COM object pointer and set the pointer to null.

Definition at line 28 of file mitkUSTelemedSDKHeader.h.

Referenced by mitk::USTelemedDevice::ConnectDeviceChangeSink(), mitk::USTelemedImageSource::CreateAndConnectConverterPlugin(), mitk::USTelemedProbesControls::CreateProbesCollection(), mitk::USTelemedProbesControls::CreateProbesSet(), mitk::telemed::CreateUsgControl(), mitk::USTelemedDevice::OnConnection(), mitk::USTelemedBModeControls::ReleaseControls(), mitk::USTelemedDevice::ReleaseUsgControls(), USTelemedScanConverterPlugin::SetScanConverterPlugin(), mitk::USTelemedImageSource::~USTelemedImageSource(), mitk::USTelemedProbe::~USTelemedProbe(), and mitk::USTelemedProbesControls::~USTelemedProbesControls().

SET_TelemedValue

#define SET_TelemedValue	(		control,
			value
	)

Cast the value to LONG and set it at the given COM object.

Definition at line 43 of file mitkUSTelemedSDKHeader.h.

Referenced by mitk::USTelemedBModeControls::OnSetScanningDepth(), mitk::USTelemedBModeControls::OnSetScanningDynamicRange(), mitk::USTelemedBModeControls::OnSetScanningFrequency(), mitk::USTelemedBModeControls::OnSetScanningGain(), mitk::USTelemedBModeControls::OnSetScanningPower(), and mitk::USTelemedBModeControls::OnSetScanningRejection().