DataPropertyIndexClient Class
The DataPropertyIndexClient class provides a ROS service abstraction for data properties exploration. More...
| Header: | #include "ontologenius/clientsIndex/ontologyClients/DataPropertyIndexClient.h" |
| Inherits: | OntologyIndexClient |
| Namespace: | onto |
Public Functions
| DataPropertyIndexClient(const std::string& name) | |
| std::vector<int64_t> | getDown(int64_t index, int depth = -1) |
| std::vector<int64_t> | getDisjoint(int64_t index) |
| std::vector<int64_t> | getDomain(int64_t index, int depth = -1) |
| std::vector<int64_t> | getRange(int64_t index) |
Reimplemented Public Functions
- 10 public functions inherited from OntologyIndexClient
- 2 public functions inherited from ClientBaseIndex
Detailed Description
The DataPropertyIndexClient class provides an abstraction of ontologenius data properties ROS service.
The ontologenius data properties service allows the exploration of data properties contained by ontologenius core using indexes.
This class is based on ClientBaseIndex and so ensure a persistent connection with ontologenius/data_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 DataPropertyClient class, this one provides access to the interface based on indexes (integers) for better performances.
See also DataPropertyClient.
See also IndividualIndexClient, ClassIndexClient and ObjectPropertyIndexClient.
Public Function Documentation
DataPropertyIndexClient::DataPropertyIndexClient(const std::string& name)
Constructs a data property 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> DataPropertyIndexClient::getDown(int64_t index, int depth = -1)
Gives all properties 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.
std::vector<int64_t> DataPropertyIndexClient::getDisjoint(int64_t index)
Gives all the disjoint properties of the property index.
std::vector<int64_t> DataPropertyIndexClient::getDomain(int64_t index, int depth = -1)
Gives all the domain classes of the property index.
The optional depth 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.
std::vector<int64_t> DataPropertyIndexClient::getRange(int64_t index)
Gives all the ranges types of the property index.