ExperimentDevice_DispatchWrapper Struct Reference

DispatchWrapper for the ExperimentDevice_Dispatch COM interface. More...

#include <ExperimentDeviceProxy.hpp>

Inheritance diagram for ExperimentDevice_DispatchWrapper:

Collaboration diagram for ExperimentDevice_DispatchWrapper:

Public Member Functions
auto	GetName () -> std::wstring
	Returns the name of the device as a std::wstring

Additional Inherited Members
Public Types inherited from DispatchWrapper<::ExperimentDevice_Dispatch >
using	type

Detailed Description

DispatchWrapper for the ExperimentDevice_Dispatch COM interface.

Inherits ::ExperimentDevice_Dispatch and overloads the C++ method GetName(), which converts the COM BSTR return value to a std::wstring. Other methods inherited from the base dispatch type are accessible via operator-> on the ExperimentDeviceProxy owning pointer.

Instances are managed exclusively through the ExperimentDeviceProxy owning smart pointer.

See also

ExperimentDeviceProxy

pacemaker::inca::detail::COMProxy

Definition at line 25 of file ExperimentDeviceProxy.hpp.

Member Function Documentation

GetName()

auto GetName ( ) -> std::wstring

inlinenodiscard

Returns the name of the device as a std::wstring

Calls the base ExperimentDevice_Dispatch::GetName(), which returns a _bstr_t. The BSTR is converted to std::wstring using SysStringLen so that the caller works entirely with standard C++ string types.

Returns

Wide string containing the device name as configured in INCA.

Definition at line 36 of file ExperimentDeviceProxy.hpp.

---

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

• src/pacemaker/inca/com/ExperimentDeviceProxy.hpp