ObjectPropertyIndexClient Class
The ObjectPropertyIndexClient class provides a ROS service abstraction for object properties exploration. More...
| Ros1 Package: | ontologenius |
| Ros2 Package: | ontopy |
| Inherits: | OntologyIndexClient |
Methods
| __init__(self, name) | |
| integer[] | getDown(self, index, depth = -1) |
| integer[] | getDisjoint(self, index) |
| integer[] | getDomain(self, index, depth = -1) |
| integer[] | getRange(self, index, depth = -1) |
| integer[] | getInverse(self, index) |
Reimplemented Methods
- 10 methods inherited from OntologyIndexClient
- 2 methods inherited from ClientIndexBase
Detailed Description
The ObjectPropertyIndexClient class provides an abstraction of ontologenius object properties ROS service.
The ontologenius object properties service allows the exploration of object properties contained by ontologenius core based on indexes.
This class is based on ClientIndexBase and so ensure a persistent connection with ontologenius/object_property_index service. The persistent connection ensures a minimal response time. A reconnection logic is implemented in the event that the persistent connection fails.
At the difference of the usual ObjectPropertyClient class, this one provides access to the interface based on indexes (integers) for better performances.
See also ObjectPropertyClient.
See also ClassIndexClient, IndividualIndexClient and DataPropertyIndexClient.
Methods Documentation
__init__(self, name)
Constructs a class client.
Can be used in a multi-ontology mode by specifying the name of the ontology name(str). For classic use, name should be defined as ''.
getDown(self, index, depth = -1)
Gives all properties (integer[]) below the one given in the parameter: index(integer).
The optional depth(integer) parameter can be set to limit tree propagation to a specific value. The default value -1 represents no propagation limitation.
getDisjoint(self, index)
Gives all the disjoint properties (integer[]) of the property index(integer).
getDomain(self, index, depth = -1)
Gives all the domain classes (integer[]) of the property index(integer).
The optional depth(int) parameter can be set to limit tree propagation to a specific value. The default value -1 represents no propagation limitation while the value 0 corresponds to the direct domains.
getRange(self, index, depth = -1)
Gives all the ranges classes (integer[]) of the property index(integer).
The optional depth(int) parameter can be set to limit tree propagation to a specific value. The default value -1 represents no propagation limitation while the value 0 corresponds to the direct ranges.
getInverse(self, index)
Gives all the inverses properties (integer[]) of the property index(integer).