Class IInstrumentObjectiveSettings#

Class Documentation#

class IInstrumentObjectiveSettings#

The objective settings.

Public Types

enum class Medium : std::uint8_t#

Values that represent the medium.

Values:

enumerator Other#: An enum constant representing that some other medium was used.

Public Functions

virtual bool TryGetObjectiveRef(std::wstring *objectiveRef) = 0#

Try to get reference to the objective.

Parameters:: objectiveRef – [inout] If non-null and successful, the reference to the objective is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetMedium(Medium *medium) = 0#

Try to get the medium.

Parameters:: medium – [inout] If non-null and successful, the medium is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetCorrectionCollar(double *correctioncollar) = 0#

Try to get the value of the first correction collar.

Parameters:: correctioncollar – [inout] If non-null and successful, the value of the first correction collar is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetCorrectionCollar2(double *correctioncollar2) = 0#

Try to get the value of the second correction collar.

Parameters:: correctioncollar2 – [inout] If non-null and successful, the value of the second correction collar is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetCorrectionControllerMode(std::wstring *correctioncontrollermode) = 0#

Try to get the mode of the correction controller.

Parameters:: correctioncontrollermode – [inout] If non-null and successful, the mode of the correction controller is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetCorrectionControllerBottomThickness(double *correctioncontrollerbottomthickness) = 0#

Try to get the bottom thickness of the correction controller.

Parameters:: correctioncontrollerbottomthickness – [inout] If non-null and successful, the bottom thickness of the correction controller is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetCorrectionControllerImagingDepth(double *correctioncontrollerimagingdepth) = 0#

Try to get the imaging depth of the correction controller.

Parameters:: correctioncontrollerimagingdepth – [inout] If non-null and successful, the imaging depth of the correction controller is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetRefractiveIndex(double *refractiveindex) = 0#

Try to get the refractive index of the immersion medium.

Parameters:: refractiveindex – [inout] If non-null and successful, the refractive index of the immersion medium is placed here.
Returns:: {bool} True if it succeeds, false if it fails.