omero.sys package

Module contents

class omero.sys.EventContext(shareId=0, sessionId=0, sessionUuid='', userId=0, userName='', groupId=0, groupName='', isAdmin=False, eventId=0, eventType='', memberOfGroups=None, leaderOfGroups=None, groupPermissions=None)

Bases: Ice.Object

Maps the ome.system.EventContext interface. Represents the information known by the server security system about the current user login.

_ice_type = <IcePy.TypeInfo object at 0x2c9acf0>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.sys.EventContextPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.sys.Filter(unique=None, ownerId=None, groupId=None, offset=None, limit=None, startTime=None, endTime=None)

Bases: Ice.Object

Provides common filters which MAY be applied to a query. Check the documentation for the particular method for more information on how these values will be interpreted as well as default values if they are missing. In general they are intended to mean:

unique := similar to SQL’s “”DISTINCT”” keyword

ownerId := (some) objects queried should belong to this user

groupId := (some) objects queried should belong to this group

preferOwner := true implies if if ownerId and groupId are both defined, use only ownerId

offset/limit := represent a page which should be loaded Note: servers may choose to impose a maximum limit.

start/endTime := (some) objects queried shoud have been created and/or modified within time span.

_ice_type = <IcePy.TypeInfo object at 0x2c9ad20>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.sys.FilterPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.sys.Options(leaves=None, orphan=None, acquisitionData=None)

Bases: Ice.Object

Similar to Filter, provides common options which MAY be applied on a given method. Check each interface’s documentation for more details.

leaves := whether or not graph leaves (usually images) should be loaded

orphan := whether or not orphaned objects (e.g. datasets not in a project) should be loaded

acquisition...:= whether or not acquisitionData (objectives, etc.) should be loaded

_ice_type = <IcePy.TypeInfo object at 0x2c9ad50>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.sys.OptionsPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.sys.Parameters(map=None, theFilter=None, theOptions=None)

Bases: Ice.Object

Holder for all the parameters which can be taken to a query.

_ice_type = <IcePy.TypeInfo object at 0x2c9ad80>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.sys.ParametersI(parammap=None)

Bases: omero.sys.Parameters

Helper subclass of omero.sys.Parameters for simplifying method parameter creation.

_rt(arg, rt)

if arg is None, return None, otherwise use the rt callable to wrap the argument.

acquisitionData()

add(name, rtype)

addId(id)

addIds(longs)

addLong(name, longValue)

addLongs(name, longs)

addString(name, stringValue)

allExps()

Removes the <code>experimenter</code> parameter from the map.

allGrps()

Removes the <code>group</code> parameter from the map.

allTimes()

Removes the time parameters from the map.

endTime(endTime)

Sets the value of the <code>end time</code> parameter.

exp(i)

Sets the value of the <code>experimenter</code> parameter.

getAcquisitionData()

getEndTime()

Returns the value of the <code>end time</code> parameter.

getExperimenter()

Returns the value of the <code>experimenter</code> parameter.

getGroup()

Returns the value of the <code>group</code> parameter.

getLeaves()

getLimit()

Returns the value of the limit parameter.

getOffset()

Returns the value of the offset parameter.

getOrphan()

getStartTime()

Returns the value of the <code>start time</code> parameter.

getUnique()

grp(i)

Sets the value of the <code>group</code> parameter.

isEndTime()

Returns <code>true</code> if the map contains the <code>end time</code> parameter, <code>false</code> otherwise.

isExperimenter()

Returns <code>true</code> if the filter contains and <code>ownerId</code> parameter, <code>false</code> otherwise.

isGroup()

Returns <code>true</code> if the filter contains an <code>groupId</code>, <code>false</code> otherwise.

isPagination()

Returns True if the filter contains a limit OR an offset, False otherwise.

isStartTime()

Returns <code>true</code> if the map contains the <code>startTime</code> parameter, <code>false</code> otherwise.

leaves()

noAcquisitionData()

noLeaves()

noOrphan()

noPage()

Nulls both the Filter.limit and Filter.offset values.

noUnique()

orphan()

page(offset, limit)

Sets both the Filter.limit and Filter.offset values by wrapping the arguments in omero.RInts if necessary.

startTime(startTime)

Sets the value of the <code>start time</code> parameter.

unique()

class omero.sys.ParametersPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.sys.Principal(name='', group='', eventType='', umask=None)

Bases: Ice.Object

Principal used for login, etc.

_ice_type = <IcePy.TypeInfo object at 0x2c9adb0>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.sys.PrincipalPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.sys.Roles(rootId=0, rootName='', systemGroupId=0, systemGroupName='', userGroupId=0, userGroupName='', guestId=0, guestName='', guestGroupId=0, guestGroupName='')

Bases: Ice.Object

Server-constants used for determining particular groups and users.

_ice_type = <IcePy.TypeInfo object at 0x2c9ade0>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.sys.RolesPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)