LightSourceData (omero-gateway 5.6.9 API)

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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARC` Indicates that the light source is a `arc`.
`static java.lang.String`	`FILAMENT` Indicates that the light source is a `filament`.
`static java.lang.String`	`LASER` Indicates that the light source is a `laser`.
`static java.lang.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.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getKind()` Returns the kind of light source.
`int`	`getLaserFrequencyMultiplication()` Returns the frequency multiplication of the laser.
`java.lang.String`	`getLaserMedium()` Returns the laser's medium.
`java.lang.Object`	`getLaserPockelCell()` Returns the pockel cell flag of the laser.
`java.lang.String`	`getLaserPulse()` Returns the pulse of the laser.
`LightSourceData`	`getLaserPump()` Returns the pump.
`omero.model.Frequency`	`getLaserRepetitionRate(omero.model.enums.UnitsFrequency unit)` Returns the repetition rate (Hz) if the laser is repetitive.
`java.lang.Object`	`getLaserTuneable()` Returns the value of the `tuneable` field or `null` if no value set.
`omero.model.Length`	`getLaserWavelength(omero.model.enums.UnitsLength unit)` Returns the laser's wavelength.
`java.lang.String`	`getLightSourceModel()` Returns the model of the light source.
`java.lang.String`	`getLotNumber()` Returns the lot of number the light source.
`java.lang.String`	`getManufacturer()` Returns the manufacturer of the light source.
`omero.model.Power`	`getPower(omero.model.enums.UnitsPower unit)` Returns the power of the light source.
`java.lang.String`	`getSerialNumber()` Returns the serial number of the light source.
`java.lang.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, asPlaneInfo, 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

- Field Detail
  - LASER
```
public static final java.lang.String LASER
```
    Indicates that the light source is a laser.
  - FILAMENT
```
public static final java.lang.String FILAMENT
```
    Indicates that the light source is a filament.
  - ARC
```
public static final java.lang.String ARC
```
    Indicates that the light source is a arc.
  - LIGHT_EMITTING_DIODE
```
public static final java.lang.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 java.lang.String getSerialNumber()
```
    Returns the serial number of the light source.
    
    Returns:
    
    See above.
  - getLotNumber
```
public java.lang.String getLotNumber()
```
    Returns the lot of number the light source.
    
    Returns:
    
    See above.
  - getManufacturer
```
public java.lang.String getManufacturer()
```
    Returns the manufacturer of the light source.
    
    Returns:
    
    See above.
  - getLightSourceModel
```
public java.lang.String getLightSourceModel()
```
    Returns the model of the light source.
    
    Returns:
    
    See above.
  - getPower
```
public omero.model.Power getPower(omero.model.enums.UnitsPower unit)
                           throws ome.model.units.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:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - getType
```
public java.lang.String getType()
```
    Returns the type of light.
    
    Returns:
    
    See above.
  - getLaserMedium
```
public java.lang.String getLaserMedium()
```
    Returns the laser's medium.
    
    Returns:
    
    See above.
  - getLaserWavelength
```
public omero.model.Length getLaserWavelength(omero.model.enums.UnitsLength unit)
                                      throws ome.model.units.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:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - getLaserTuneable
```
public java.lang.Object getLaserTuneable()
```
    Returns the value of the tuneable field or null if no value set.
    
    Returns:
    
    See above.
  - getKind
```
public java.lang.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 java.lang.String getLaserPulse()
```
    Returns the pulse of the laser.
    
    Returns:
    
    See above
  - getLaserPockelCell
```
public java.lang.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 ome.model.units.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:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - getLaserPump
```
public LightSourceData getLaserPump()
```
    Returns the pump.
    
    Returns:
    
    See above.

Class LightSourceData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class omero.gateway.model.DataObject

Methods inherited from class java.lang.Object

Field Detail

LASER

FILAMENT

ARC

LIGHT_EMITTING_DIODE

Constructor Detail

LightSourceData

Method Detail

getSerialNumber

getLotNumber

getManufacturer

getLightSourceModel

getPower

getType

getLaserMedium

getLaserWavelength

getLaserTuneable

getKind

hasPump

getLaserFrequencyMultiplication

getLaserPulse

getLaserPockelCell

getLaserRepetitionRate

getLaserPump