Package omero :: Package gateway :: Class _WellWrapper
[hide private]
[frames] | no frames]

Class _WellWrapper

source code


omero_model_WellI class wrapper extends BlitzObjectWrapper.

Instance Methods [hide private]
 
__bstrap__(self)
Initialisation method which is implemented by subclasses to set their class variables etc.
source code
 
__prepare__(self, **kwargs)
Initialisation method which is implemented by subclasses to handle various init tasks
source code
 
__reset__(self)
Clears child cache, so next _listChildren will query the server
source code
 
__loadedHotSwap__(self)
Loads the object that is wrapped by this class.
source code
generator of Ice client proxy objects for the child nodes
_listChildren(self, **kwargs)
Lists available child objects.
source code
 
simpleMarshal(self, xtra=None, parents=False)
Creates a dict representation of this object.
source code
list of BlitzObjectWrapper ( or tuple(BlitzObjectWrapper, BlitzObjectWrapper) )
listParents(self, withlinks=False)
Because wells are direct children of plates, with no links in between, a special listParents is needed
source code
 
getScreens(self)
returns the screens that link to plates that link to this well
source code
Boolean
isWellSample(self)
Return True if well samples exist (loaded)
source code
Int
countWellSample(self)
Return the number of well samples loaded
source code
WellSampleWrapper
getWellSample(self, index=None)
Return the well sample at the specified index.
source code
ImageWrapper
getImage(self, index=None)
Return the image at the specified well sample index.
source code
WellSampleWrapper
selectedWellSample(self)
Return the well sample at the current index (0 if not set)
source code

Inherited from BlitzObjectWrapper: __eq__, __getattr__, __init__, __repr__, canDelete, canOwnerWrite, canWrite, countChildren, countChildren_cached, creationEventDate, findChildByName, getAncestry, getAnnotation, getChildLinks, getDate, getDescription, getDetails, getId, getName, getOwner, getOwnerFullName, getOwnerOmeName, getParent, getParentLinks, isEditable, isLeaded, isOwned, isPrivate, isPublic, isReadOnly, isShared, linkAnnotation, listAnnotations, listChildren, listOrphanedAnnotations, removeAnnotations, save, saveAs, setDescription, setName, unlinkAnnotations, updateEventDate

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from BlitzObjectWrapper: LINK_PARENT

Class Variables [hide private]

Inherited from BlitzObjectWrapper: CHILD_WRAPPER_CLASS, LINK_CHILD, LINK_CLASS, OMERO_CLASS, PARENT_WRAPPER_CLASS

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__bstrap__(self)

source code 

Initialisation method which is implemented by subclasses to set their class variables etc.

Overrides: BlitzObjectWrapper.__bstrap__
(inherited documentation)

__prepare__(self, **kwargs)

source code 

Initialisation method which is implemented by subclasses to handle various init tasks

Overrides: BlitzObjectWrapper.__prepare__
(inherited documentation)

__loadedHotSwap__(self)

source code 

Loads the object that is wrapped by this class. This includes linked objects. This method can be overwritten by subclasses that want to specify how/which linked objects are loaded.

Overrides: BlitzObjectWrapper.__loadedHotSwap__
(inherited documentation)

_listChildren(self, **kwargs)

source code 

Lists available child objects.

Returns: generator of Ice client proxy objects for the child nodes
child objects.
Overrides: BlitzObjectWrapper._listChildren
(inherited documentation)

simpleMarshal(self, xtra=None, parents=False)

source code 

Creates a dict representation of this object.
E.g. for Image: {'description': '', 'author': 'Will Moore', 'date': 1286332557.0,
    'type': 'Image', 'id': 3841L, 'name': 'cb_4_w500_t03_z01.tif'}

@param xtra:        A dict of extra keys to include. E.g. 'childCount'
@type xtra:         Dict
@param parents:     If True, include a list of ancestors (in simpleMarshal form) as 'parents'
@type parents:      Boolean
@return:            A dict representation of this object
@rtype:             Dict

Overrides: BlitzObjectWrapper.simpleMarshal
(inherited documentation)

listParents(self, withlinks=False)

source code 

Because wells are direct children of plates, with no links in between, a special listParents is needed

Parameters:
  • withlinks - if true each yielded result will be a tuple of (linkobj, obj)
Returns: list of BlitzObjectWrapper ( or tuple(BlitzObjectWrapper, BlitzObjectWrapper) )
the parent objects, with or without the links depending on args
Overrides: BlitzObjectWrapper.listParents

isWellSample(self)

source code 

Return True if well samples exist (loaded)

Returns: Boolean
True if well samples loaded

countWellSample(self)

source code 

Return the number of well samples loaded

Returns: Int
well sample count

getWellSample(self, index=None)

source code 

Return the well sample at the specified index. If index is ommited, the currently selected index is used instead (self.index) and if that is not defined, the first one (index 0) is returned.

Parameters:
  • index (integer) - the well sample index
Returns: WellSampleWrapper
The Well Sample

getImage(self, index=None)

source code 

Return the image at the specified well sample index. If index is ommited, the currently selected index is used instead (self.index) and if that is not defined, the first one (index 0) is returned.

Parameters:
  • index (integer) - the well sample index
Returns: ImageWrapper
The Image

selectedWellSample(self)

source code 

Return the well sample at the current index (0 if not set)

Returns: WellSampleWrapper
The Well Sample wrapper