ClassIndexClient Class
The ClassIndexClient class provides a ROS service abstraction for classes exploration based on indexes. More...
| Header: | #include "ontologenius/clientsIndex/ontologyClients/ClassIndexClient.h" |
| Inherits: | OntologyIndexClient |
| Namespace: | onto |
Public Functions
| ClassIndexClient(const std::string& name) | |
| std::vector<int64_t> | getDown(int64_t index, int depth = -1, int64_t selector = 0) |
| std::vector<int64_t> | getDisjoint(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 class_from, int64_t class_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) |
Reimplemented Public Functions
- 10 public functions inherited from OntologyIndexClient
- 2 public functions inherited from ClientBaseIndex
Detailed Description
The ClassIndexClient class provides an abstraction of ontologenius classes ROS service.
The ontologenius classes service allows the exploration of classes contained by ontologenius core using indexes.
This class is based on ClientBaseIndex and so ensure a persistent connection with ontologenius/class_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 ClassClient class, this one provides access to the interface based on indexes (integers) for better performances.
See also ClassClient.
See also IndividualIndexClient, DataPropertyIndexClient and ObjectPropertyIndexClient.
Public Function Documentation
ClassIndexClient::ClassIndexClient(const string& name)
Constructs a class client.
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> ClassIndexClient::getDown(int64_t index, int depth = -1, int64_t selector = 0)
Gives all classes below the one given in the parameter: index.
The optional depth parameter can be set to limit tree propagation to a specific value. The default value -1 represents no propagation limitation.
The optional selector parameter can be set to only get results inheriting from the selector class. The default value 0 represents no restriction on the result.
std::vector<int64_t> ClassIndexClient::getDisjoint(int64_t index)
Gives all the disjoint classes of the one given in the parameter: index.
std::vector<int64_t> ClassIndexClient::getOn(int64_t index, int64_t property, int64_t selector = 0)
Gives all the classes pointed by the property property and applied to the class index.
The optional selector parameter can be set to only get results inheriting from the selector class. The default value 0 represents no restriction on the result.
std::vector<int64_t> ClassIndexClient::getFrom(int64_t property, int64_t index, int64_t selector = 0)
Gives all the classes having the given property property and pointing to the class index.
The optional selector parameter can be set to only get results inheriting from the selector class. The default value 0 represents no restriction on the result.
std::vector<int64_t> ClassIndexClient::getWith(int64_t class_from, int64_t class_to, int64_t selector = 0, int depth = -1)
Gives all the properties linking the two classes class_from and class_to.
The optional selector parameter can be set to only get results inheriting from the selector property. The default value 0 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> ClassIndexClient::getRelatedFrom(int64_t property)
Gives all the classes possessing the property property.
std::vector<int64_t> ClassIndexClient::getRelatedOn(int64_t property)
Gives all the classes pointed to by the property property.
std::vector<int64_t> ClassIndexClient::getRelatedWith(int64_t index)
Gives all the classes having a property pointing to the class index.
std::vector<int64_t> ClassIndexClient::getRelationFrom(int64_t index, int depth = -1)
Gives all the properties applied to the class 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> ClassIndexClient::getRelationOn(int64_t index, int depth = -1)
Gives all the properties going to the class 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> ClassIndexClient::getRelationWith(int64_t index)
Gives all the classes pointed by a property applied to the class index.
std::vector<int64_t> ClassIndexClient::getDomainOf(int64_t index, int64_t selector = 0, int depth = -1)
Gives all the properties for which the class 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 0 represents no restriction on the result.
The optional depth parameter can be set to limit tree propagation of the class to a specific value. The default value -1 represents no propagation limitation.
std::vector<int64_t> ClassIndexClient::getRangeOf(int64_t index, int64_t selector = 0, int depth = -1)
Gives all the properties for which the class 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 0 represents no restriction on the result.
The optional depth parameter can be set to limit tree propagation of the class to a specific value. The default value -1 represents no propagation limitation.