ecl-logo Documentation

DiscardSamplesOptions

DiscardSamplesOptions[objects]resolvedOptions

returns the resolved options for DiscardSamples when it is called on objects.

Details

  • This function returns the resolved options that would be fed to DiscardSamples if it were called on these input objects.
  • Input
    Output
    General Options

Examples

Basic Examples  (3)

Returns all options for: Mark a sample for disposal; it and its container will be discarded once they are not in use by any experiment:

Returns all options for: Mark a plate for disposal; all samples within the container will be discarded:

Returns all options for: Mark multiple samples for disposal:

Additional Examples  (3)

Returns all options for: Mark multiple containers for disposal; all samples within the containers are also marked for disposal:

Returns all options for: Mark a mixed list of samples and containers for disposal:

Returns all options for: Marking a sample for disposal marks both the sample and its container as AwaitingDisposal:

Options  (6)

DiscardContainer  (5)

Returns all options for: Indicate that the container of a fluid sample should be thrown out:

Returns all options for: Normally, if a container is marked as reusable in its Model, discarding it will direct it to be dishwashed and restocked:

Returns all options for: Set DiscardContainer to True to indicate that a normally reusable container should no longer be considered reusable, and be thrown out instead of dishwashed:

Returns all options for: If a container is marked as non-reusable, discarding it will direct it to be thrown out:

Returns all options for: Non-reusable containers must always be thrown out; DiscardContainer cannot be set to False:

OutputFormat  (1)

Choose to return options as a List or Table:

Messages  (6)

ConflictingConditionsInContainer  (1)

Returns all options for when not all samples within the same container are provided:

ContainerDiscardRequired  (1)

Returns all options for when Samples in non-reusable containers must be discarded along with their containers; DiscardContainer cannot be set to False:

DiscardedInputs  (1)

Returns all options for when Samples already discarded cannot be discarded again:

InputLengthMismatch  (1)

Returns Error if DiscardContainer is provided as a list, the list must have the same length as the input list:

ItemsContainerless  (1)

Returns all options for: The DiscardContainer option will be ignored for items that are not moved around the lab inside an associated container:

OutstandingResources  (1)

Returns all options for: samples with outstanding resources are discarded; the samples will not actually be discarded until the outstanding resources are fulfilled: