org.micromanager.acquisition

Interface ScopeDataUtils.ApplyOptions

Enclosing interface:

ScopeDataUtils

public static interface ScopeDataUtils.ApplyOptions

Options for controlling how ScopeData is applied to hardware.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ScopeDataUtils.ApplyOptions.Builder Builder for ApplyOptions.

Method Summary

Modifier and Type	Method and Description
static ScopeDataUtils.ApplyOptions.Builder	builder() Returns a new builder for ApplyOptions.
static ScopeDataUtils.ApplyOptions	defaults() Returns default options: skip read-only, skip unchanged, validate first.
java.util.Set<java.lang.String>	getExcludedDevices() Returns set of device labels to exclude entirely.
java.util.Set<java.lang.String>	getExcludedKeys() Returns set of property keys to exclude (in "DeviceLabel-PropertyName" format).
boolean	isSkipMissingDevices() If true, skip properties for missing devices instead of reporting errors.
boolean	isSkipReadOnly() If true, skip read-only properties instead of reporting errors.
boolean	isSkipUnchanged() If true, skip properties whose values already match current hardware.
boolean	isStrictMode() If true, stop on first error.
boolean	isValidateFirst() If true, validate before applying.

Method Detail

defaults

static ScopeDataUtils.ApplyOptions defaults()

Returns default options: skip read-only, skip unchanged, validate first.

builder

static ScopeDataUtils.ApplyOptions.Builder builder()

Returns a new builder for ApplyOptions.

isStrictMode

boolean isStrictMode()

If true, stop on first error. If false, continue with remaining properties.

isSkipReadOnly

boolean isSkipReadOnly()

If true, skip read-only properties instead of reporting errors.

isSkipMissingDevices

boolean isSkipMissingDevices()

If true, skip properties for missing devices instead of reporting errors.

isSkipUnchanged

boolean isSkipUnchanged()

If true, skip properties whose values already match current hardware.

isValidateFirst

boolean isValidateFirst()

If true, validate before applying.

getExcludedKeys

java.util.Set<java.lang.String> getExcludedKeys()

Returns set of property keys to exclude (in "DeviceLabel-PropertyName" format).

getExcludedDevices

java.util.Set<java.lang.String> getExcludedDevices()

Returns set of device labels to exclude entirely.