omero.gateway.model

Class FilterData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.FilterData

public class FilterData
extends DataObject

Object hosting a filter.

Since:

3.0-Beta4

Constructor Summary

Constructors

Constructor and Description
FilterData(omero.model.Filter filter) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
omero.model.Length	getCutIn(omero.model.enums.UnitsLength unit) Returns the cut in value or null.
omero.model.Length	getCutInTolerance(omero.model.enums.UnitsLength unit) Returns the cut in tolerance value or null.
omero.model.Length	getCutOut(omero.model.enums.UnitsLength unit) Returns the cut out value or null.
omero.model.Length	getCutOutTolerance(omero.model.enums.UnitsLength unit) Returns the cut out tolerance value or null.
java.lang.String	getFilterWheel() Returns the wheel.
java.lang.String	getLotNumber() Returns the lot number.
java.lang.String	getManufacturer() Returns the manufacturer.
java.lang.String	getModel() Returns the model.
java.lang.String	getSerialNumber() Returns the serial number.
java.lang.Double	getTransmittance() Returns the cut out tolerance value or -1.
java.lang.String	getType() Returns the type.

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

FilterData

public FilterData(omero.model.Filter filter)

Creates a new instance.

Parameters:

filter - The filter to host. Mustn't be null.

Method Detail

getCutIn

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

Returns the cut in value or null.

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

getCutInTolerance

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

Returns the cut in tolerance value or null.

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

getCutOut

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

Returns the cut out value or null.

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

getCutOutTolerance

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

Returns the cut out tolerance value or null.

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

getTransmittance

public java.lang.Double getTransmittance()

Returns the cut out tolerance value or -1.

Returns:

See above.

getManufacturer

public java.lang.String getManufacturer()

Returns the manufacturer.

Returns:

See above.

getModel

public java.lang.String getModel()

Returns the model.

Returns:

See above.

getLotNumber

public java.lang.String getLotNumber()

Returns the lot number.

Returns:

See above.

getSerialNumber

public java.lang.String getSerialNumber()

Returns the serial number.

Returns:

See above.

getType

public java.lang.String getType()

Returns the type. One out of a predefined list.

Returns:

See above.

getFilterWheel

public java.lang.String getFilterWheel()

Returns the wheel.

Returns:

See above.