IndividualClient Class
The IndividualClient class provides a ROS service abstraction for individuals exploration. More...
| Header: | #include "ontologenius/clients/ontologyClients/IndividualClient.h" |
| Inherits: | OntologyClient |
| Namespace: | onto |
Public Functions
| IndividualClient(const std::string& name) | |
| std::vector<std::string> | getType(const std::string& name) |
| std::vector<std::string> | getSame(const std::string& name) |
| std::vector<std::string> | getDistincts(const std::string& name) |
| std::vector<std::string> | getOn(const std::string& name, const std::string& property, const std::string& selector = "") |
| std::vector<std::string> | getFrom(const std::string& property, const std::string& name, const std::string& selector = "") |
| std::vector<std::string> | getWith(const std::string& name_from, const std::string& name_to, const std::string& selector = "", int depth = -1) |
| std::vector<std::string> | getRelatedFrom(const std::string& property) |
| std::vector<std::string> | getRelatedOn(const std::string& property) |
| std::vector<std::string> | getRelatedWith(const std::string& name) |
| std::vector<std::string> | getRelationFrom(const std::string& name, int depth = -1) |
| std::vector<std::string> | getRelationOn(const std::string& name, int depth = -1) |
| std::vector<std::string> | getRelationWith(const std::string& name) |
| std::vector<std::string> | getDomainOf(const std::string& name, const std::string& selector = "", int depth = -1) |
| std::vector<std::string> | getRangeOf(const std::string& name, const std::string& selector = "", int depth = -1) |
| bool | isInferred(const std::string& subject, const std::string& property, const std::string& object) |
| bool | isInferred(const std::string& subject, const std::string& class_name) |
| std::vector<std::string> | getInferenceExplanation(const std::string& subject, const std::string& property, const std::string& object) |
| std::vector<std::string> | getInferenceExplanation(const std::string& subject, const std::string& class_name) |
Reimplemented Public Functions
- 10 public functions inherited from OntologyClient
- 2 public functions inherited from ClientBase
Detailed Description
The IndividualClient class provides an abstraction of ontologenius individuals ROS service.
The ontologenius individuals' service allows the exploration of individuals contained by ontologenius core.
This class is based on ClientBase 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.
See also ClassClient, DataPropertyClient and ObjectPropertyClient.
Public Function Documentation
IndividualClient::IndividualClient(const std::string& name)
Constructs an individual 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<std::string> IndividualClient::getType(const std::string& name)
Gives all the individuals of the type of the given class name.
std::vector<std::string> IndividualClient::getSame(const std::string& name)
Gives all the individuals that are defined as being identical to the individual name.
std::vector<std::string> IndividualClient::getDistincts(const std::string& name)
Gives all the defined individuals as being distinct from the individual name.
std::vector<std::string> IndividualClient::getOn(const std::string& name, const std::string& property, const std::string& selector = "")
Gives all the individuals pointed by the property property and applied to the individual name.
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<std::string> IndividualClient::getFrom(const std::string& property, const std::string& name, const std::string& selector = "")
Gives all the individuals having the given property property and pointing to the individual name.
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<std::string> IndividualClient::getWith(const std::string& name_from, const std::string& name_to, const std::string& selector = "", int depth = -1)
Gives all the properties linking the individual name_from to the individual name_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<std::string> IndividualClient::getRelatedFrom(const std::string& property)
Gives all the individuals possessing the property property.
std::vector<std::string> IndividualClient::getRelatedOn(const std::string& property)
Gives all the individuals pointed to by the property property.
std::vector<std::string> IndividualClient::getRelatedWith(const std::string& name)
Gives all the individuals having a property pointing to the individual name.
std::vector<std::string> IndividualClient::getRelationFrom(const std::string& name, int depth = -1)
Gives all the properties applied to the individual name.
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<std::string> IndividualClient::getRelationOn(const std::string& name, int depth = -1)
Gives all the properties going to the individual name.
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<std::string> IndividualClient::getRelationWith(const std::string& name)
Gives all the individuals pointed by a property applied to the individual name.
std::vector<std::string> IndividualClient::getDomainOf(const std::string& name, const std::string& selector = "", int depth = -1)
Gives all the properties for which the individual name 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<std::string> IndividualClient::getRangeOf(const std::string& name, const std::string& selector = "", int depth = -1)
Gives all the properties for which the individual name 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 IndividualClient::isInferred(const std::string& subject, const std::string& property, const std::string& object)
Tests if the relation has been inferred or not.
bool IndividualClient::isInferred(const std::string& subject, const std::string& class_name)
Tests if the inheritance has been inferred or not.
std::vector<std::string> IndividualClient::getInferenceExplanation(const std::string& subject, const std::string& property, const std::string& object)
Gives all the relations used in the inference of the provided relation.
std::vector<std::string> IndividualClient::getInferenceExplanation(const std::string& subject, const std::string& class_name)
Gives all the relations used in the inference of the provided inheritage.