omero.gateway.model

Class LightSourceData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.LightSourceData

public class LightSourceData
extends DataObject

Object hosting a light source: filament, arc, laser or light emitting diode

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARC Indicates that the light source is a arc.
static String	FILAMENT Indicates that the light source is a filament.
static String	LASER Indicates that the light source is a laser.
static String	LIGHT_EMITTING_DIODE Indicates that the light source is a light emitting diode.

Constructor Summary

Constructors

Constructor and Description
LightSourceData(omero.model.LightSource source) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
String	getKind() Returns the kind of light source.
int	getLaserFrequencyMultiplication() Returns the frequency multiplication of the laser.
String	getLaserMedium() Returns the laser's medium.
Object	getLaserPockelCell() Returns the pockel cell flag of the laser.
String	getLaserPulse() Returns the pulse of the laser.
LightSourceData	getLaserPump() Returns the pump.
double	getLaserRepetitionRate() Deprecated. Replaced by getLaserRepetitionRate(UnitsFrequency)
omero.model.Frequency	getLaserRepetitionRate(omero.model.enums.UnitsFrequency unit) Returns the repetition rate (Hz) if the laser is repetitive.
Object	getLaserTuneable() Returns the value of the tuneable field or null if no value set.
double	getLaserWavelength() Deprecated. Replaced by getLaserWavelength(UnitsLength)
omero.model.Length	getLaserWavelength(omero.model.enums.UnitsLength unit) Returns the laser's wavelength.
String	getLightSourceModel() Returns the model of the light source.
String	getLotNumber() Returns the lot of number the light source.
String	getManufacturer() Returns the manufacturer of the light source.
double	getPower() Deprecated. Replaced by getPower(UnitsPower)
omero.model.Power	getPower(omero.model.enums.UnitsPower unit) Returns the power of the light source.
String	getSerialNumber() Returns the serial number of the light source.
String	getType() Returns the type of light.
boolean	hasPump() Returns true if the light source is a laser with a pump, false otherwise.

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, 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

Field Detail

LASER

public static final String LASER

Indicates that the light source is a laser.

FILAMENT

public static final String FILAMENT

Indicates that the light source is a filament.

ARC

public static final String ARC

Indicates that the light source is a arc.

LIGHT_EMITTING_DIODE

public static final String LIGHT_EMITTING_DIODE

Indicates that the light source is a light emitting diode.

Constructor Detail

LightSourceData

public LightSourceData(omero.model.LightSource source)

Creates a new instance.

Parameters:

source - The light source. Mustn't be null.

Method Detail

getSerialNumber

public String getSerialNumber()

Returns the serial number of the light source.

Returns:

See above.

getLotNumber

public String getLotNumber()

Returns the lot of number the light source.

Returns:

See above.

getManufacturer

public String getManufacturer()

Returns the manufacturer of the light source.

Returns:

See above.

getLightSourceModel

public String getLightSourceModel()

Returns the model of the light source.

Returns:

See above.

getPower

public omero.model.Power getPower(omero.model.enums.UnitsPower unit)
                           throws BigResult

Returns the power of the light source.

Parameters:

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

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getPower

@Deprecated
public double getPower()

Deprecated. Replaced by getPower(UnitsPower)

Returns the power of the light source.

Returns:

See above.

getType

public String getType()

Returns the type of light.

Returns:

See above.

getLaserMedium

public String getLaserMedium()

Returns the laser's medium.

Returns:

See above.

getLaserWavelength

public omero.model.Length getLaserWavelength(omero.model.enums.UnitsLength unit)
                                      throws BigResult

Returns the laser's wavelength.

Parameters:

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

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getLaserWavelength

@Deprecated
public double getLaserWavelength()

Deprecated. Replaced by getLaserWavelength(UnitsLength)

Returns the laser's wavelength.

Returns:

See above.

getLaserTuneable

public Object getLaserTuneable()

Returns the value of the tuneable field or null if no value set.

Returns:

See above.

getKind

public String getKind()

Returns the kind of light source.

Returns:

See above.

hasPump

public boolean hasPump()

Returns true if the light source is a laser with a pump, false otherwise.

Returns:

See above

getLaserFrequencyMultiplication

public int getLaserFrequencyMultiplication()

Returns the frequency multiplication of the laser.

Returns:

See above

getLaserPulse

public String getLaserPulse()

Returns the pulse of the laser.

Returns:

See above

getLaserPockelCell

public Object getLaserPockelCell()

Returns the pockel cell flag of the laser.

Returns:

See above

getLaserRepetitionRate

public omero.model.Frequency getLaserRepetitionRate(omero.model.enums.UnitsFrequency unit)
                                             throws BigResult

Returns the repetition rate (Hz) if the laser is repetitive.

Parameters:

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

Returns:

See above.

Throws:

BigResult - If an arithmetic under-/overflow occurred

getLaserRepetitionRate

@Deprecated
public double getLaserRepetitionRate()

Deprecated. Replaced by getLaserRepetitionRate(UnitsFrequency)

Returns the repetition rate (Hz) if the laser is repetitive.

Returns:

See above.

getLaserPump

public LightSourceData getLaserPump()

Returns the pump.

Returns:

See above.