libCZI::IInstrumentObjectiveSettings Class Reference

The objective settings. More...

#include <libCZI_Metadata2.h>

Public Types
enum class	Medium : std::uint8_t {   Air , Oil , Water , Glycerol ,   Other }
	Values that represent the medium. More...

Public Member Functions
virtual bool	TryGetObjectiveRef (std::wstring *objectiveRef)=0
virtual bool	TryGetMedium (Medium *medium)=0
virtual bool	TryGetCorrectionCollar (double *correctioncollar)=0
virtual bool	TryGetCorrectionCollar2 (double *correctioncollar2)=0
virtual bool	TryGetCorrectionControllerMode (std::wstring *correctioncontrollermode)=0
virtual bool	TryGetCorrectionControllerBottomThickness (double *correctioncontrollerbottomthickness)=0
virtual bool	TryGetCorrectionControllerImagingDepth (double *correctioncontrollerimagingdepth)=0
virtual bool	TryGetRefractiveIndex (double *refractiveindex)=0

Detailed Description

The objective settings.

Member Enumeration Documentation

Medium

enum libCZI::IInstrumentObjectiveSettings::Medium : std::uint8_t

strong

Values that represent the medium.

Enumerator
Air	An enum constant representing the medium air.
Oil	An enum constant representing the medium oil.
Water	An enum constant representing the medium water.
Glycerol	An enum constant representing the medium glycerol.
Other	An enum constant representing that some other medium was used.

Member Function Documentation

TryGetCorrectionCollar()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetCorrectionCollar ( double *  correctioncollar )

pure virtual

Try to get the value of the first correction collar.

Parameters

[in,out]

correctioncollar

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.

TryGetCorrectionCollar2()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetCorrectionCollar2 ( double *  correctioncollar2 )

pure virtual

Try to get the value of the second correction collar.

Parameters

[in,out]

correctioncollar2

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.

TryGetCorrectionControllerBottomThickness()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetCorrectionControllerBottomThickness ( double *  correctioncontrollerbottomthickness )

pure virtual

Try to get the bottom thickness of the correction controller.

Parameters

[in,out]

correctioncontrollerbottomthickness

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.

TryGetCorrectionControllerImagingDepth()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetCorrectionControllerImagingDepth ( double *  correctioncontrollerimagingdepth )

pure virtual

Try to get the imaging depth of the correction controller.

Parameters

[in,out]

correctioncontrollerimagingdepth

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.

TryGetCorrectionControllerMode()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetCorrectionControllerMode ( std::wstring *  correctioncontrollermode )

pure virtual

Try to get the mode of the correction controller.

Parameters

[in,out]

correctioncontrollermode

If non-null and successful, the mode of the correction controller is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetMedium()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetMedium ( Medium *  medium )

pure virtual

Try to get the medium.

Parameters

[in,out]

medium

If non-null and successful, the medium is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetObjectiveRef()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetObjectiveRef ( std::wstring *  objectiveRef )

pure virtual

Try to get reference to the objective.

Parameters

[in,out]

objectiveRef

If non-null and successful, the reference to the objective is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetRefractiveIndex()

virtual bool libCZI::IInstrumentObjectiveSettings::TryGetRefractiveIndex ( double *  refractiveindex )

pure virtual

Try to get the refractive index of the immersion medium.

Parameters

[in,out]

refractiveindex

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.

---

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

• libCZI/libCZI_Metadata2.h