IndividualIndexClient Class
The IndividualIndexClient class provides a ROS service abstraction for individuals exploration. More...
| Header: | #include "ontologenius/clientsIndex/ontologyClients/IndividualIndexClient.h" |
| Inherits: | OntologyIndexClient |
| Namespace: | onto |
Public Functions
| IndividualIndexClient(const std::string& name) | |
| std::vector<int64_t> | getType(int64_t index) |
| std::vector<int64_t> | getSame(int64_t index) |
| std::vector<int64_t> | getDistincts(int64_t index) |
| std::vector<int64_t> | getOn(int64_t index, int64_t property, int64_t selector = 0) |
| std::vector<int64_t> | getFrom(int64_t property, int64_t index, int64_t selector = 0) |
| std::vector<int64_t> | getWith(int64_t index_from, int64_t index_to, int64_t selector = 0, int depth = -1) |
| std::vector<int64_t> | getRelatedFrom(int64_t property) |
| std::vector<int64_t> | getRelatedOn(int64_t property) |
| std::vector<int64_t> | getRelatedWith(int64_t index) |
| std::vector<int64_t> | getRelationFrom(int64_t index, int depth = -1) |
| std::vector<int64_t> | getRelationOn(int64_t index, int depth = -1) |
| std::vector<int64_t> | getRelationWith(int64_t index) |
| std::vector<int64_t> | getDomainOf(int64_t index, int64_t selector = 0, int depth = -1) |
| std::vector<int64_t> | getRangeOf(int64_t index, int64_t selector = 0, int depth = -1) |
| bool | isInferred(int64_t subject, int64_t property, int64_t object) |
| bool | isInferred(int64_t subject, int64_t class_index) |
| std::vector<std::string> | getInferenceExplanation(int64_t subject, int64_t property, int64_t object) |
| std::vector<std::string> | getInferenceExplanation(int64_t subject, int64_t class_index) |
Reimplemented Public Functions
- 10 public functions inherited from OntologyIndexClient
- 2 public functions inherited from ClientBaseIndex
Detailed Description
The IndividualIndexClient class provides an abstraction of ontologenius individuals ROS service.
The ontologenius individuals' service allows the exploration of individuals contained by ontologenius core using indexes
This class is based on ClientBaseIndex and so ensure a persistent connection with ontologenius/individual 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 IndividualClient class, this one provides access to the interface based on indexes (integers) for better performances.
See also IndividualClient.
See also ClassIndexClient, DataPropertyIndexClient and ObjectPropertyIndexClient.
Public Function Documentation
IndividualIndexClient::IndividualIndexClient(const std::string& name)
Constructs an individual client with.
Can be used in a multi-ontology mode by specifying the name of the ontology name. For classic use, name should be defined as "".
std::vector<int64_t> IndividualIndexClient::getType(int64_t index)
Gives all the individuals of the type of the given class index.
std::vector<int64_t> IndividualIndexClient::getSame(int64_t index)
Gives all the individuals that are defined as being identical to the individual index.
std::vector<int64_t> IndividualIndexClient::getDistincts(int64_t index)
Gives all the defined individuals as being distinct from the individual index.
std::vector<int64_t> IndividualIndexClient::getOn(int64_t index, int64_t property, int64_t selector = 0)
Gives all the individuals pointed by the property property and applied to the individual index.
The optional selector parameter can be set to only get results inheriting from the selector class. The default value "" represents no restriction on the result.
std::vector<int64_t> IndividualIndexClient::getFrom(int64_t property, int64_t index, int64_t selector = 0)
Gives all the individuals having the given property property and pointing to the individual index.
The optional selector parameter can be set to only get results inheriting from the selector class. The default value "" represents no restriction on the result.
std::vector<int64_t> IndividualIndexClient::getWith(int64_t index_from, int64_t index_to, int64_t selector = 0, int depth = -1)
Gives all the properties linking the individual index_from to the individual index_to.
The optional selector parameter can be set to only get results inheriting from the selector property. The default value "" represents no restriction on the result.
The optional depth parameter can be set to limit tree propagation to a specific value. The default value -1 represents no propagation limitation.
std::vector<int64_t> IndividualIndexClient::getRelatedFrom(int64_t property)
Gives all the individuals possessing the property property.
std::vector<int64_t> IndividualIndexClient::getRelatedOn(int64_t property)
Gives all the individuals pointed to by the property property.
std::vector<int64_t> IndividualIndexClient::getRelatedWith(int64_t index)
Gives all the individuals having a property pointing to the individual index.
std::vector<int64_t> IndividualIndexClient::getRelationFrom(int64_t index, int depth = -1)
Gives all the properties applied to the individual index.
The optional depth parameter can be set to limit tree propagation to a specific value. The default value -1 represents no propagation limitation.
std::vector<int64_t> IndividualIndexClient::getRelationOn(int64_t index, int depth = -1)
Gives all the properties going to the individual index.
The optional depth parameter can be set to limit tree propagation to a specific value. The default value -1 represents no propagation limitation.
std::vector<int64_t> IndividualIndexClient::getRelationWith(int64_t index)
Gives all the individuals pointed by a property applied to the individual name.
std::vector<int64_t> IndividualIndexClient::getDomainOf(int64_t index, int64_t selector = 0, int depth = -1)
Gives all the properties for which the individual index is part of the domain.
The optional selector parameter can be set to only get results inheriting from the selector property. The default value "" represents no restriction on the result.
The optional depth parameter can be set to limit tree propagation of the individual to a specific value. The default value -1 represents no propagation limitation.
std::vector<int64_t> IndividualIndexClient::getRangeOf(int64_t index, int64_t selector = 0, int depth = -1)
Gives all the properties for which the individual index is part of the range.
The optional selector parameter can be set to only get results inheriting from the selector property. The default value "" represents no restriction on the result.
The optional depth parameter can be set to limit tree propagation of the individual to a specific value. The default value -1 represents no propagation limitation.
bool IndividualIndexClient::isInferred(int64_t subject, int64_t property, int64_t object)
Tests if the relation has been inferred or not.
bool IndividualIndexClient::isInferred(int64_t subject, int64_t class_index)
Tests if the inheritance has been inferred or not.
std::vector<std::string> IndividualIndexClient::getInferenceExplanation(int64_t subject, int64_t property, int64_t object)
Gives all the relations used in the inference of the provided relation.
Relations are returned in their string form.
std::vector<std::string> IndividualIndexClient::getInferenceExplanation(int64_t subject, int64_t class_index)
Gives all the relations used in the inference of the provided inheritage.
Relations are returned in their string form.