omero.model

Class DetectorSettingsI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.DetectorSettings

omero.model.DetectorSettingsI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _DetectorSettingsOperations, _DetectorSettingsOperationsNC, _IObjectOperations, _IObjectOperationsNC

public class DetectorSettingsI
extends DetectorSettings
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BINNING
static java.lang.String	DETAILS
static java.lang.String	DETECTOR
static java.lang.String	GAIN
static java.lang.String	INTEGRATION
static java.lang.String	OFFSETVALUE
static java.lang.String	READOUTRATE
static java.lang.String	VOLTAGE
static java.lang.String	ZOOM

Fields inherited from class omero.model.DetectorSettings

__ids, binning, detector, gain, integration, offsetValue, readOutRate, serialVersionUID, version, voltage, zoom

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
DetectorSettingsI()
DetectorSettingsI(long id, boolean loaded)
DetectorSettingsI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
static java.util.List<DetectorSettingsI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
void	copyObject(ome.util.Filterable model, ome.util.ModelMapper _mapper) Used by IceMapper to inject an "ome.model" object into this "omero.model" object.
protected void	errorIfUnloaded()
ome.util.Filterable	fillObject(ome.util.ReverseModelMapper _mapper) Used by IceMapper produce an "ome.model" object from this "omero.model" object.
Binning	getBinning(Ice.Current current)
Details	getDetails(Ice.Current current)
Detector	getDetector(Ice.Current current)
RDouble	getGain(Ice.Current current)
RLong	getId(Ice.Current current)
RInt	getIntegration(Ice.Current current)
RDouble	getOffsetValue(Ice.Current current)
Frequency	getReadOutRate(Ice.Current current)
RInt	getVersion(Ice.Current current)
ElectricPotential	getVoltage(Ice.Current current)
RDouble	getZoom(Ice.Current current)
boolean	isAnnotated(Ice.Current current) Allows for the attachment of any omero.model.Annotation subclasses.
boolean	isGlobal(Ice.Current current) Marker interface which means that special rules apply for both reading and writing these instances.
boolean	isLink(Ice.Current current) A link between two other types.
boolean	isLoaded(Ice.Current current) Tests if the objects are loaded or not.
boolean	isMutable(Ice.Current current) The server will persist changes made to these types.
IObject	proxy(Ice.Current current) Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );
void	setBinning(Binning binning, Ice.Current current)
void	setDetector(Detector detector, Ice.Current current)
void	setGain(RDouble gain, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setIntegration(RInt integration, Ice.Current current)
void	setOffsetValue(RDouble offsetValue, Ice.Current current)
void	setReadOutRate(Frequency readOutRate, Ice.Current current)
void	setVersion(RInt version, Ice.Current current)
void	setVoltage(ElectricPotential voltage, Ice.Current current)
void	setZoom(RDouble zoom, Ice.Current current)
IObject	shallowCopy(Ice.Current current) Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.
protected void	throwNullCollectionException(java.lang.String propertyName)
protected void	toggleCollectionsLoaded(boolean load)
void	unload(Ice.Current current) Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.
void	unloadBinning()
void	unloadCollections(Ice.Current current) Each collection can also be unloaded, independently of the object itself.
void	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadDetector()
void	unloadGain()
void	unloadIntegration()
void	unloadOffsetValue()
void	unloadReadOutRate()
void	unloadVoltage()
void	unloadZoom()

Methods inherited from class omero.model.DetectorSettings

___getBinning, ___getDetector, ___getGain, ___getIntegration, ___getOffsetValue, ___getReadOutRate, ___getVersion, ___getVoltage, ___getZoom, ___setBinning, ___setDetector, ___setGain, ___setIntegration, ___setOffsetValue, ___setReadOutRate, ___setVersion, ___setVoltage, ___setZoom, __dispatch, __readImpl, __writeImpl, clone, getBinning, getDetector, getGain, getIntegration, getOffsetValue, getReadOutRate, getVersion, getVoltage, getZoom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setBinning, setDetector, setGain, setIntegration, setOffsetValue, setReadOutRate, setVersion, setVoltage, setZoom

Methods inherited from class omero.model.IObject

___getDetails, ___getId, ___isAnnotated, ___isGlobal, ___isLink, ___isLoaded, ___isMutable, ___proxy, ___setId, ___shallowCopy, ___unload, ___unloadCollections, ___unloadDetails, getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface omero.model._IObjectOperationsNC

getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Field Detail

VOLTAGE

public static final java.lang.String VOLTAGE

See Also:

Constant Field Values

GAIN

public static final java.lang.String GAIN

See Also:

Constant Field Values

OFFSETVALUE

public static final java.lang.String OFFSETVALUE

See Also:

Constant Field Values

READOUTRATE

public static final java.lang.String READOUTRATE

See Also:

Constant Field Values

BINNING

public static final java.lang.String BINNING

See Also:

Constant Field Values

INTEGRATION

public static final java.lang.String INTEGRATION

See Also:

Constant Field Values

ZOOM

public static final java.lang.String ZOOM

See Also:

Constant Field Values

DETECTOR

public static final java.lang.String DETECTOR

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

DetectorSettingsI

public DetectorSettingsI()

DetectorSettingsI

public DetectorSettingsI(long id,
                         boolean loaded)

DetectorSettingsI

public DetectorSettingsI(RLong id,
                         boolean loaded)

Method Detail

errorIfUnloaded

protected void errorIfUnloaded()
                        throws UnloadedEntityException

Throws:

UnloadedEntityException

throwNullCollectionException

protected void throwNullCollectionException(java.lang.String propertyName)
                                     throws UnloadedCollectionException

Throws:

UnloadedCollectionException

toggleCollectionsLoaded

protected void toggleCollectionsLoaded(boolean load)

unload

public void unload(Ice.Current current)

Description copied from interface: _IObjectOperations

Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.

Specified by:

unload in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLoaded

public boolean isLoaded(Ice.Current current)

Description copied from interface: _IObjectOperations

Tests if the objects are loaded or not. If this value is false, then any method call on this instance other than getId or setId will result in an exception.

Specified by:

isLoaded in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

unloadCollections

public void unloadCollections(Ice.Current current)

Description copied from interface: _IObjectOperations

Each collection can also be unloaded, independently of the object itself. To unload all collections, use: object.unloadCollections(); This is useful when it is possible that a collection no longer represents the state in the database, and passing the collections back to the server might delete some entities. Sending back empty collections can also save a significant amount of bandwidth, when working with large data graphs.

Specified by:

unloadCollections in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isGlobal

public boolean isGlobal(Ice.Current current)

Description copied from interface: _IObjectOperations

Marker interface which means that special rules apply for both reading and writing these instances.

Specified by:

isGlobal in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isMutable

public boolean isMutable(Ice.Current current)

Description copied from interface: _IObjectOperations

The server will persist changes made to these types. Methods provided: - getVersion() - setVersion()

Specified by:

isMutable in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isAnnotated

public boolean isAnnotated(Ice.Current current)

Description copied from interface: _IObjectOperations

Allows for the attachment of any omero.model.Annotation subclasses. Methods provided are: - linkAnnotation(Annotation) -

Specified by:

isAnnotated in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLink

public boolean isLink(Ice.Current current)

Description copied from interface: _IObjectOperations

A link between two other types. Methods provided: - getParent() - getChild()

Specified by:

isLink in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

shallowCopy

public IObject shallowCopy(Ice.Current current)

Description copied from interface: _IObjectOperations

Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.

Specified by:

shallowCopy in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

proxy

public IObject proxy(Ice.Current current)

Description copied from interface: _IObjectOperations

Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );

Specified by:

proxy in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

getId

public RLong getId(Ice.Current current)

Specified by:

getId in interface _IObjectOperations

setId

public void setId(RLong id,
                  Ice.Current current)

Specified by:

setId in interface _IObjectOperations

getDetails

public Details getDetails(Ice.Current current)

Specified by:

getDetails in interface _IObjectOperations

unloadDetails

public void unloadDetails(Ice.Current current)

Description copied from interface: _IObjectOperations

As with collections, the objects under details can link to many other objects. Unloading the details can same bandwidth and simplify the server logic.

Specified by:

unloadDetails in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

getVersion

public RInt getVersion(Ice.Current current)

Specified by:

getVersion in interface _DetectorSettingsOperations

setVersion

public void setVersion(RInt version,
                       Ice.Current current)

Specified by:

setVersion in interface _DetectorSettingsOperations

unloadVoltage

public void unloadVoltage()

getVoltage

public ElectricPotential getVoltage(Ice.Current current)
                             throws UnloadedEntityException

Specified by:

getVoltage in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setVoltage

public void setVoltage(ElectricPotential voltage,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:

setVoltage in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

unloadGain

public void unloadGain()

getGain

public RDouble getGain(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getGain in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setGain

public void setGain(RDouble gain,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setGain in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

unloadOffsetValue

public void unloadOffsetValue()

getOffsetValue

public RDouble getOffsetValue(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getOffsetValue in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setOffsetValue

public void setOffsetValue(RDouble offsetValue,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

setOffsetValue in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

unloadReadOutRate

public void unloadReadOutRate()

getReadOutRate

public Frequency getReadOutRate(Ice.Current current)
                         throws UnloadedEntityException

Specified by:

getReadOutRate in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setReadOutRate

public void setReadOutRate(Frequency readOutRate,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

setReadOutRate in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

unloadBinning

public void unloadBinning()

getBinning

public Binning getBinning(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getBinning in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setBinning

public void setBinning(Binning binning,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:

setBinning in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

unloadIntegration

public void unloadIntegration()

getIntegration

public RInt getIntegration(Ice.Current current)
                    throws UnloadedEntityException

Specified by:

getIntegration in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setIntegration

public void setIntegration(RInt integration,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

setIntegration in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

unloadZoom

public void unloadZoom()

getZoom

public RDouble getZoom(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getZoom in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setZoom

public void setZoom(RDouble zoom,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setZoom in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

unloadDetector

public void unloadDetector()

getDetector

public Detector getDetector(Ice.Current current)
                     throws UnloadedEntityException

Specified by:

getDetector in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

setDetector

public void setDetector(Detector detector,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:

setDetector in interface _DetectorSettingsOperations

Throws:

UnloadedEntityException

copyObject

public void copyObject(ome.util.Filterable model,
                       ome.util.ModelMapper _mapper)

Used by IceMapper to inject an "ome.model" object into this "omero.model" object.

Specified by:

copyObject in interface ome.model.ModelBased

fillObject

public ome.util.Filterable fillObject(ome.util.ReverseModelMapper _mapper)

Used by IceMapper produce an "ome.model" object from this "omero.model" object.

Specified by:

fillObject in interface ome.model.ModelBased

cast

public static java.util.List<DetectorSettingsI> cast(java.util.List list)

Casts (without warning) the given list to a list of the current type.

Throws:

java.lang.ClassCastException