DetectorSettings (OME XML library 6.3.4 API)

java.lang.Object
- ome.xml.model.AbstractOMEModelObject
- - ome.xml.model.Reference
  - - ome.xml.model.Settings
    - - ome.xml.model.DetectorSettings

All Implemented Interfaces:: OMEModelObject

public class DetectorSettings
extends Settings

Field Summary

Fields
Modifier and Type Field and Description

static String NAMESPACE

Fields
Modifier and Type	Field and Description
`static String`	`NAMESPACE`

Constructor Summary

Constructors
Constructor and Description
`DetectorSettings()` Default constructor.
`DetectorSettings(DetectorSettings orig)` Copy constructor.
`DetectorSettings(Element element, OMEModel model)` Constructs DetectorSettings recursively from an XML DOM tree.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Element`	`asXMLElement(Document document)` Takes the entire object hierarchy and produces an XML DOM tree.
`Element`	`asXMLElement(Document document, Element DetectorSettings_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`Binning`	`getBinning()`
`Detector`	`getDetector()`
`Double`	`getGain()`
`String`	`getID()` Retrieves the reference's target object ID.
`PositiveInteger`	`getIntegration()`
`Double`	`getOffset()`
`Frequency`	`getReadOutRate()`
`static String`	`getReadOutRateUnitXsdDefault()`
`ElectricPotential`	`getVoltage()`
`static String`	`getVoltageUnitXsdDefault()`
`Double`	`getZoom()`
`boolean`	`link(Reference reference, OMEModelObject o)` Link a given OME model object to this model object.
`void`	`setBinning(Binning binning)`
`void`	`setDetector(Detector detector)`
`void`	`setGain(Double gain)`
`void`	`setID(String id)` Sets the reference's target object ID.
`void`	`setIntegration(PositiveInteger integration)`
`void`	`setOffset(Double offset)`
`void`	`setReadOutRate(Frequency readOutRate)`
`void`	`setVoltage(ElectricPotential voltage)`
`void`	`setZoom(Double zoom)`
`void`	`update(Element element, OMEModel model)` Updates DetectorSettings recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DetectorSettings
```
public DetectorSettings()
```
    Default constructor.
  - DetectorSettings
```
public DetectorSettings(Element element,
                        OMEModel model)
                 throws EnumerationException
```
    Constructs DetectorSettings recursively from an XML DOM tree.
    
    Parameters:
    
    element - Root of the XML DOM tree to construct a model object graph from.
    
    model - Handler for the OME model which keeps track of instances and references seen during object population.
    
    Throws:
    
    EnumerationException - If there is an error instantiating an enumeration during model object creation.
  - DetectorSettings
```
public DetectorSettings(DetectorSettings orig)
```
    Copy constructor.
- Method Detail
  - update
```
public void update(Element element,
                   OMEModel model)
            throws EnumerationException
```
    Updates DetectorSettings recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
    
    Specified by:
    
    update in interface OMEModelObject
    
    Overrides:
    
    update in class Settings
    
    Parameters:
    
    element - Root of the XML DOM tree to construct a model object graph from.
    
    model - Handler for the OME model which keeps track of instances and references seen during object population.
    
    Throws:
    
    EnumerationException - If there is an error instantiating an enumeration during model object creation.
  - link
```
public boolean link(Reference reference,
                    OMEModelObject o)
```
    Description copied from interface: OMEModelObject
    
    Link a given OME model object to this model object.
    
    Specified by:
    
    link in interface OMEModelObject
    
    Overrides:
    
    link in class Settings
    
    Parameters:
    
    reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.
    
    o - Model object to link to.
    
    Returns:
    
    true if this model object was able to handle the reference, false otherwise.
  - getID
```
public String getID()
```
    Description copied from class: Reference
    
    Retrieves the reference's target object ID.
    
    Specified by:
    
    getID in class Reference
    
    Returns:
    
    See above.
  - setID
```
public void setID(String id)
```
    Description copied from class: Reference
    
    Sets the reference's target object ID.
    
    Specified by:
    
    setID in class Reference
    
    Parameters:
    
    id - The object ID to set.
  - getOffset
```
public Double getOffset()
```
  - setOffset
```
public void setOffset(Double offset)
```
  - getGain
```
public Double getGain()
```
  - setGain
```
public void setGain(Double gain)
```
  - getVoltage
```
public ElectricPotential getVoltage()
```
  - setVoltage
```
public void setVoltage(ElectricPotential voltage)
```
  - getVoltageUnitXsdDefault
```
public static String getVoltageUnitXsdDefault()
```
  - getZoom
```
public Double getZoom()
```
  - setZoom
```
public void setZoom(Double zoom)
```
  - getReadOutRate
```
public Frequency getReadOutRate()
```
  - setReadOutRate
```
public void setReadOutRate(Frequency readOutRate)
```
  - getReadOutRateUnitXsdDefault
```
public static String getReadOutRateUnitXsdDefault()
```
  - getBinning
```
public Binning getBinning()
```
  - setBinning
```
public void setBinning(Binning binning)
```
  - getIntegration
```
public PositiveInteger getIntegration()
```
  - setIntegration
```
public void setIntegration(PositiveInteger integration)
```
  - getDetector
```
public Detector getDetector()
```
  - setDetector
```
public void setDetector(Detector detector)
```
  - asXMLElement
```
public Element asXMLElement(Document document)
```
    Description copied from interface: OMEModelObject
    
    Takes the entire object hierarchy and produces an XML DOM tree.
    
    Specified by:
    
    asXMLElement in interface OMEModelObject
    
    Overrides:
    
    asXMLElement in class Settings
    
    Parameters:
    
    document - Destination document for element creation, etc.
    
    Returns:
    
    XML DOM tree root element for this model object.
  - asXMLElement
```
public Element asXMLElement(Document document,
                            Element DetectorSettings_element)
```
    Description copied from class: AbstractOMEModelObject
    
    Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
    
    Overrides:
    
    asXMLElement in class Settings
    
    Parameters:
    
    document - Destination document for element creation, etc.
    
    DetectorSettings_element - Element from the subclass. If null a new element will be created of this class.
    
    Returns:
    
    element populated with properties from this class.

Class DetectorSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

Constructor Detail

DetectorSettings

DetectorSettings

DetectorSettings

Method Detail

update

link

getID

setID

getOffset

setOffset

getGain

setGain

getVoltage

setVoltage

getVoltageUnitXsdDefault

getZoom

setZoom

getReadOutRate

setReadOutRate

getReadOutRateUnitXsdDefault

getBinning

setBinning

getIntegration

setIntegration

getDetector

setDetector

asXMLElement

asXMLElement