pacemaker::inca::com Namespace Reference

Classes
struct	CalibrationScalarData_DispatchWrapper
	Dispatch Wrapper for the CalibrationScalarData_Dispatch COM interface. More...
struct	ExperimentDevice_DispatchWrapper
	DispatchWrapper for the ExperimentDevice_Dispatch COM interface. More...
struct	Inca_DispatchWrapper
	DispatchWrapper for the top-level Inca_Dispatch COM interface. More...
struct	IncaExperimentView_DispatchWrapper
	DispatchWrapper for the IncaExperimentView_Dispatch COM interface. More...
struct	IncaOnlineExperiment_DispatchWrapper
	DispatchWrapper for the IncaOnlineExperiment_Dispatch COM interface. More...

Typedefs
using	CalibrationScalarDataProxy = pacemaker::inca::detail::COMProxy<CalibrationScalarData_DispatchWrapper>
	Owning smart-pointer proxy for an INCA calibration scalar data COM object.
using	ExperimentDeviceProxy = pacemaker::inca::detail::COMProxy<ExperimentDevice_DispatchWrapper>
	Owning smart-pointer proxy for an INCA experiment device object.
using	IncaExperimentViewProxy = pacemaker::inca::detail::COMProxy<IncaExperimentView_DispatchWrapper>
	Owning smart-pointer proxy for the INCA experiment-view COM object.
using	IncaOnlineExperimentProxy = pacemaker::inca::detail::COMProxy<IncaOnlineExperiment_DispatchWrapper>
	Owning smart-pointer proxy for the INCA online experiment COM object.
using	IncaProxy = pacemaker::inca::detail::COMProxy<Inca_DispatchWrapper>
	Owning smart-pointer proxy for the top-level INCA COM object.

Typedef Documentation

CalibrationScalarDataProxy

using CalibrationScalarDataProxy = pacemaker::inca::detail::COMProxy<CalibrationScalarData_DispatchWrapper>

Owning smart-pointer proxy for an INCA calibration scalar data COM object.

CalibrationScalarDataProxy is a type alias for pacemaker::inca::detail::COMProxy<CalibrationScalarData_DispatchWrapper>.

Method	Description
SetImplValue(double)	Writes a new value to the parameter's implementation page.
ResetValueToRP()	Restores the parameter to its reference-page baseline.

The proxy is move-only. Copying is deleted via the unique_ptr base.

See also

CalibrationScalarData_DispatchWrapper

pacemaker::inca::detail::COMProxy

IncaOnlineExperiment_DispatchWrapper::GetCalibrationValueInDevice()

pacemaker::inca::Session::set_param()

pacemaker::inca::Session::reset()

Definition at line 54 of file CalibrationScalarDataProxy.hpp.

ExperimentDeviceProxy

using ExperimentDeviceProxy = pacemaker::inca::detail::COMProxy<ExperimentDevice_DispatchWrapper>

Owning smart-pointer proxy for an INCA experiment device object.

ExperimentDeviceProxy is a type alias for pacemaker::inca::detail::COMProxy<ExperimentDevice_DispatchWrapper>.

Use operator-> to call GetName() or any other inherited COM method, and get() (inherited from unique_ptr) to obtain the non-owning raw ExperimentDevice_DispatchWrapper* required by IncaOnlineExperiment_DispatcWrapper::GetCalibrationValueInDevice():

ExperimentDeviceProxy device{rawIDispatch};
std::wstring name = device->GetName();
// Pass the raw pointer to another COM call:
auto param = exp->GetCalibrationValueInDevice("Foo", device.get());

The proxy is move-only. Copying is deleted via the unique_ptr base.

See also

ExperimentDevice_DispatchWrapper

pacemaker::inca::detail::COMProxy

IncaOnlineExperiment_DispatchWrapper::GetAllDevice()

IncaOnlineExperiment_DispatchWrapper::GetCalibrationValueInDevice()

Definition at line 65 of file ExperimentDeviceProxy.hpp.

IncaExperimentViewProxy

using IncaExperimentViewProxy = pacemaker::inca::detail::COMProxy<IncaExperimentView_DispatchWrapper>

Owning smart-pointer proxy for the INCA experiment-view COM object.

IncaExperimentViewProxy is a type alias for pacemaker::inca::detail::COMProxy<IncaExperimentView_DispatchWrapper>.

All methods of ::IncaExperimentView_Dispatch are accessible via operator->:

IncaExperimentViewProxy view{rawIDispatch};
view->OpenViewForExperimentDataItem(dataItemPtr.get());

The proxy is move-only. Copying is deleted via the unique_ptr base.

See also

IncaExperimentView_DispatchWrapper

pacemaker::inca::detail::COMProxy

pacemaker::inca::Session

Definition at line 42 of file IncaExperimentViewProxy.hpp.

IncaOnlineExperimentProxy

using IncaOnlineExperimentProxy = pacemaker::inca::detail::COMProxy<IncaOnlineExperiment_DispatchWrapper>

Owning smart-pointer proxy for the INCA online experiment COM object.

IncaOnlineExperimentProxy is a type alias for pacemaker::inca::detail::COMProxy<IncaOnlineExperiment_DispatchWrapper>.

Use operator-> to access both the C++ helper methods defined on IncaOnlineExperiment_DisaptchWrapper and the inherited COM methods

IncaOnlineExperimentProxy exp{rawIDispatch};
auto devices = exp->GetAllDevices(); // overloaded C++ method
exp->StartRecording();               // inherited COM method
exp->StopRecordingAndSave();         // inherited COM method
exp->StopMeasurement();              // inherited COM method

The proxy is move-only. Copying is deleted via the unique_ptr base.

See also

IncaOnlineExperiment_DispatchWrapper

pacemaker::inca::detail::COMProxy

pacemaker::inca::Session

Definition at line 116 of file IncaOnlineExperimentProxy.hpp.

IncaProxy

using IncaProxy = pacemaker::inca::detail::COMProxy<Inca_DispatchWrapper>

Owning smart-pointer proxy for the top-level INCA COM object.

IncaProxy is a type alias for pacemaker::inca::detail::COMProxy<Inca_DispatchWrapper>. It is the first object constructed when establishing an INCA automation session and is the sole owner of the root Inca_Dispatch COM interface pointer.

Use operator-> to access the methods of Inca_DispatchWrapper:

IncaProxy proxy{rawIDispatch};
auto exp     = proxy->GetOpenedExperiment();
auto expview = proxy->GetOpenedExperimentView();

The proxy is move-only. Copying is deleted via the unique_ptr base.

Note

DisconnectFromTool() is not called in the proxy's destructor. It is responsibility of Session destructor to call proxy->DisconnectFromTool() before the proxy is destroyed.

See also

Inca_DispatchWrapper

pacemaker::inca::detail::COMProxy

pacemaker::inca::Session

Definition at line 75 of file IncaProxy.hpp.