pycram.designators.object_designator

Classes

OntologyObjectDesignatorDescription	Description for Objects that can be found using ontological reasoning
BelieveObject	Description for Objects that are only believed in.
ResolutionStrategyObject	Class for object designator_description descriptions.
ObjectPart	Object Designator Descriptions for Objects that are part of some other object.

Module Contents

class pycram.designators.object_designator.OntologyObjectDesignatorDescription(search_result: owlready2.triplelite._SearchList)

Description for Objects that can be found using ontological reasoning

search_result: pycram.external_interfaces.robokudo.List

The result from the search in the ontology.

__iter__() → typing_extensions.Iterable[pycram.world_concepts.world_object.Object]

Returns:

The objects in the current world which match the search result in the ‘is_a’ relation.

class pycram.designators.object_designator.BelieveObject(names: typing_extensions.Optional[typing_extensions.List[str]] = None, types: typing_extensions.Optional[typing_extensions.List[typing_extensions.Type[pycrap.ontologies.PhysicalObject]]] = None)

Bases: pycram.external_interfaces.robokudo.ObjectDesignatorDescription

Description for Objects that are only believed in.

class pycram.designators.object_designator.ResolutionStrategyObject(strategy: typing_extensions.Union[pycram.external_interfaces.robokudo.Callable, typing_extensions.Iterable])

Bases: pycram.external_interfaces.robokudo.ObjectDesignatorDescription

Class for object designator_description descriptions. Descriptions hold possible parameter ranges for object designators.

strategy

create_iterator(resolution_strategy: typing_extensions.Union[pycram.external_interfaces.robokudo.Callable, typing_extensions.Iterable])

Creates an iterator for the given method. If the method is iterable it will be used as is, otherwise it will be called as a function.

Parameters:

resolution_strategy – The method to create an iterator for.

Returns:

An iterator for the given method.

__iter__() → typing_extensions.Iterable[pycram.world_concepts.world_object.Object]

Iterates through every possible solution for the given solution strategy.

Returns:

A resolved object designator

class pycram.designators.object_designator.ObjectPart(names: pycram.external_interfaces.robokudo.List[str], part_of: typing_extensions.Union[pycram.world_concepts.world_object.Object, typing_extensions.Iterable[pycram.world_concepts.world_object.Object]], type: pycram.external_interfaces.robokudo.Optional[pycram.datastructures.enums.ObjectType] = None)

Bases: pycram.external_interfaces.robokudo.ObjectDesignatorDescription, typing_extensions.Iterable[pycram.description.ObjectDescription.Link]

Object Designator Descriptions for Objects that are part of some other object.

type: pycram.external_interfaces.robokudo.Optional[pycram.datastructures.enums.ObjectType] = None

names: pycram.external_interfaces.robokudo.Optional[pycram.external_interfaces.robokudo.List[str]]

part_of

ground() → pycram.description.ObjectDescription.Link

Default specialized_designators, returns the first result of the iterator of this instance.

Returns:

A resolved object designator

__iter__() → typing_extensions.Iterator[pycram.description.ObjectDescription.Link]

Iterates through every possible solution for the given input parameter.

Yield:

A resolved Object designator