omero.rtypes module

Module which is responsible for creating rtypes from static factory methods. Where possible, factory methods return cached values (the fly-weight pattern) such that <code>rbool(true) == rbool(true)</code> might hold true.

This module is meant to be kept in sync with the abstract Java class omero.rtypes as well as the omero/rtypes.{h,cpp} files.

class rtypes.ObjectFactory(*args: Any, **kwargs: Any)

Bases: ObjectFactory

create(string)

destroy()

register(ic)

class rtypes.RArrayI(*args: Any, **kwargs: Any)

Bases: RArray

Guaranteed to never contain an empty list.

add(value, current=None)

addAll(values, current=None)

compare(rhs, current=None)

get(index, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

size(current=None)

class rtypes.RBoolI(*args: Any, **kwargs: Any)

Bases: RBool

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RClassI(*args: Any, **kwargs: Any)

Bases: RClass

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RDoubleI(*args: Any, **kwargs: Any)

Bases: RDouble

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RFloatI(*args: Any, **kwargs: Any)

Bases: RFloat

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RIntI(*args: Any, **kwargs: Any)

Bases: RInt

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RInternalI(*args: Any, **kwargs: Any)

Bases: RInternal

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RListI(*args: Any, **kwargs: Any)

Bases: RList

Guaranteed to never contain an empty list.

add(value, current=None)

addAll(values, current=None)

compare(rhs, current=None)

get(index, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

size(current=None)

class rtypes.RLongI(*args: Any, **kwargs: Any)

Bases: RLong

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RMapI(*args: Any, **kwargs: Any)

Bases: RMap

compare(rhs, current=None)

get(key, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

put(key, value, current=None)

size(current=None)

class rtypes.RObjectI(*args: Any, **kwargs: Any)

Bases: RObject

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RSetI(*args: Any, **kwargs: Any)

Bases: RSet

Guaranteed to never contain an empty list.

add(value, current=None)

addAll(values, current=None)

compare(rhs, current=None)

get(index, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

size(current=None)

class rtypes.RStringI(*args: Any, **kwargs: Any)

Bases: RString

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

class rtypes.RTimeI(*args: Any, **kwargs: Any)

Bases: RTime

compare(rhs, current=None)

getValue(current=None)

ice_postUnmarshal()

Provides additional initialization once all data loaded Required due to __getattr__ implementation.

ice_preMarshal()

Provides additional validation before data is sent Required due to __getattr__ implementation.

rtypes.rarray(val=None, *args)

rtypes.rbool(val)

Returns the argument itself if None or an instance of RBool. Otherwise, checks the value for”trueness” and returns either rtrue or rfalse.

rtypes.rclass(val)

If argument is None or “”, returns emptyclass. If an RClass, returns the argument itself. Otherwise creates a new RClass

rtypes.rdouble(val)

Returns the argument itself if None or an instance of RDouble. Otherwise, assigns a coerced float to the value of a new RDouble.

rtypes.rfloat(val)

Returns the argument itself if None or an instance of RFloat. Otherwise, assigns a coerced float to the value of a new RFloat.

rtypes.rint(val)

Returns the argument itself if None or an instance of RInt. If the argument is 0, rint0 is returned. Otherwise, assigns a coerced int to the value of a new RInt

rtypes.rinternal(val)

If argument is None, returns rnullinternal. If an RInternal, returns the argument itself. Otherwise creates a new RInternal.

rtypes.rlist(val=None, *args)

rtypes.rlong(val)

Returns the argument itself if None or an instance of RLong. If the argument is 0, rlong 0 is returned. Otherwise, assigns a coerced int to the value of a new RLong

rtypes.rmap(val=None, **kwargs)

rtypes.robject(val)

If argument is None, returns rnullobject. If an RObject, returns the argument itself. Otherwise creates a new RObject

rtypes.rset(val=None, *args)

rtypes.rstring(val)

If argument is None or “”, returns emptystring. If an RString, returns the argument itself. Otherwise creates a new RString

rtypes.rtime(val)

Returns the argument itself if None or an instance of RTime. Otherwise, assigns a coerced long to the value of a new RTime

rtypes.rtype(val)

If None or an RType, return the argument itself. Otherwise, attempts to dispatch to the other omero.rtypes.* static methods to create a proper {@link RType} subclass by checking the type of the input. If no conversion is found, a {@link ClientError} is thrown.

Note: unlike the statically typed languages, the rtype implementation in Python is somewhat limited by the lack of types (float v. double) All float-like values will produce an omero.RFloat subclass. Similar problems may arise with rlong and rint

rtypes.unwrap(val, cache=None)

rtypes.wrap(val, cache=None)