Proxy for the INCA experiment-view COM object. More...

#include <IncaExperimentViewProxy.hpp>

Inheritance diagram for IncaExperimentViewProxy:

Collaboration diagram for IncaExperimentViewProxy:

Public Member Functions
	IncaExperimentViewProxy (pacemaker::inca::detail::unique_com_ptr<::IDispatch > idispatch)
	Contructs the proxy by narrowing a generic `IDispatch` to `IncaExperimentView_Dispatch`

	IncaExperimentViewProxy (IncaExperimentViewProxy &&)=default
	Move constructor transfers ownership of the COM object.

IncaExperimentViewProxy &	operator= (IncaExperimentViewProxy &&)=default
	Move assignment transfers ownership of the COM object.

	~IncaExperimentViewProxy ()
	Destructor; releases the underlying COM object.

auto	OpenViewForExperimentDataItem (pacemaker::inca::detail::unique_com_ptr<::IDispatch > dataitem) -> void
	Opens an INCA measurement view for the given calibration data item.

Detailed Description

Proxy for the INCA experiment-view COM object.

IncaExperimentViewProxy wraps the IncaExperimentView_Dispatch COM interface, which controls the graphical measurement view displayed in the INCA workbench during an active experiment.

The primary use case is opening a view panel for a specific calibration data item so that its value can be observed in real time from the INCA GUI while an automated experiment run is in progress.

The class is move-only.

See also: pacemaker::inca::com::IncaOnlineExperimentProxy::GetCalibrationValueInDevice(); pacemaker::inca::detail::COMProxy

Definition at line 28 of file IncaExperimentViewProxy.hpp.

Constructor & Destructor Documentation

◆ IncaExperimentViewProxy() [1/2]

IncaExperimentViewProxy ( pacemaker::inca::detail::unique_com_ptr<::IDispatch > idispatch )

explicit

Contructs the proxy by narrowing a generic IDispatch to IncaExperimentView_Dispatch

Parameters

idispatch Owning pointer to a generic IDispatch representing the experiment-view object. Ownership is transferred to the proxy.

Exceptions

std::invalid_argument	if `idispatch` is null.
std::runtime_error	if `QueryInterface` fails to obtain `IncaExperimentView_Dispatch`

◆ IncaExperimentViewProxy() [2/2]

IncaExperimentViewProxy ( IncaExperimentViewProxy && )

default

Move constructor transfers ownership of the COM object.

◆ ~IncaExperimentViewProxy()

~IncaExperimentViewProxy ( )

Destructor; releases the underlying COM object.

Member Function Documentation

◆ operator=()

IncaExperimentViewProxy & operator= ( IncaExperimentViewProxy && )

default

Move assignment transfers ownership of the COM object.

◆ OpenViewForExperimentDataItem()

auto OpenViewForExperimentDataItem ( pacemaker::inca::detail::unique_com_ptr<::IDispatch > dataitem ) -> void

Opens an INCA measurement view for the given calibration data item.

Forwards the raw IDispatch* held by dataitem to the underlying COM method OpenViewForExperimentDataItem. The view is displayed inside the INCA workbench UI for the duration of the experiment.

Ownership of dataitem is consumed by this call; the pointer is moved in but only the raw address is forwarded to COM. INCA does not take permanent ownership of the pointer.