omero.gateway.model

Class WellSampleData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.WellSampleData

public class WellSampleData
extends DataObject

The data that makes up an OME WellSample along with links to its images and the Experimenter that owns this WellSample.

Since:

3.0-Beta3

Constructor Summary

Constructors

Constructor and Description
WellSampleData() Creates a new instance.
WellSampleData(omero.model.WellSample wellSample) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
ImageData	getImage() Returns the image related to that sample if any.
omero.model.Length	getPositionX(omero.model.enums.UnitsLength unit) Returns the position X.
omero.model.Length	getPositionY(omero.model.enums.UnitsLength unit) Returns the position Y.
long	getStartTime() Returns the time at which the field was acquired.
void	setImage(ImageData newValue) Sets the image linked to this well sample.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WellSampleData

public WellSampleData()

Creates a new instance.

WellSampleData

public WellSampleData(omero.model.WellSample wellSample)

Creates a new instance.

Parameters:

wellSample - Back pointer to the WellSample model object. Mustn't be null.

Throws:

java.lang.IllegalArgumentException - If the object is null.

Method Detail

getImage

public ImageData getImage()

Returns the image related to that sample if any. Possible values are 0 or 1.

Returns:

See above.

setImage

public void setImage(ImageData newValue)

Sets the image linked to this well sample.

Parameters:

newValue - The image to set.

getPositionX

public omero.model.Length getPositionX(omero.model.enums.UnitsLength unit)
                                throws ome.model.units.BigResult

Returns the position X.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

ome.model.units.BigResult - If an arithmetic under-/overflow occurred

getPositionY

public omero.model.Length getPositionY(omero.model.enums.UnitsLength unit)
                                throws ome.model.units.BigResult

Returns the position Y.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

ome.model.units.BigResult - If an arithmetic under-/overflow occurred

getStartTime

public long getStartTime()

Returns the time at which the field was acquired.

Returns:

See above.