Inca_DispatchWrapper Struct Reference

DispatchWrapper for the top-level Inca_Dispatch COM interface. More...

#include <IncaProxy.hpp>

Inheritance diagram for Inca_DispatchWrapper:

Collaboration diagram for Inca_DispatchWrapper:

Public Member Functions
auto	GetOpenedExperiment () -> IncaOnlineExperimentProxy
	Returns the COM object representing the currently open experiment.
auto	GetOpenedExperimentView () -> IncaExperimentViewProxy
	Returns the COM object representing the currently open experiment view.

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

Detailed Description

DispatchWrapper for the top-level Inca_Dispatch COM interface.

Inherits ::Inca_Dispatch and overloads two C++ methods that return fully typed proxy objects instead of raw IDispatch pointers.

Instances of this type are never constructed directly; they are managed exclusively through the IncaProxy owning smart pointer.

See also

IncaProxy

pacemaker::inca::detail::COMProxy

Definition at line 25 of file IncaProxy.hpp.

Member Function Documentation

GetOpenedExperiment()

auto GetOpenedExperiment ( ) -> IncaOnlineExperimentProxy

inlinenodiscard

Returns the COM object representing the currently open experiment.

Calls the base Inca_Dispatch::GetOpenedExperiment(), detaches the returned IDispatch, and constructs an IncaOnlineExperimentProxy by narrowing the pointer via query_interface.

Returns

Owning IncaOnlineExperimentProxy for the open experiment.

Exceptions

std::runtime_error

if the base COM call fails or the resulting pointer cannot be narrowed to IncaOnlineExperiment_Dispatch.

Definition at line 37 of file IncaProxy.hpp.

GetOpenedExperimentView()

auto GetOpenedExperimentView ( ) -> IncaExperimentViewProxy

inlinenodiscard

Returns the COM object representing the currently open experiment view.

Calls the base Inca_Dispatch::GetOpenedExperimentView(), detaches the returned IDispatch, and constructs an IncaExperimentViewProxy by narrowing the pointer via query_interface.

Returns

Owning IncaExperimentViewProxy for the open experimnet view.

Exceptions

std::runtime_error

if the base COM call fails or the resulting pointer cannot be narrowed to IncaExperimentView_Dispatch.

Definition at line 49 of file IncaProxy.hpp.

---

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

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