#include <Class.h>

Inheritance diagram for knowrob::semweb::Class:

Collaboration diagram for knowrob::semweb::Class:

Classes
struct	ClassComparator

Public Member Functions
	Class (std::string_view iri)

	Class (const IRIAtomPtr &iri)

void	addDirectParent (const std::shared_ptr< Class > &directParent, std::optional< std::string_view > graph)

void	removeDirectParent (const std::shared_ptr< Class > &directParent, std::optional< std::string_view > graph)

const auto &	directParents () const

bool	isDirectSubClassOf (const std::shared_ptr< Class > &directParent)

bool	isSubClassOf (const std::shared_ptr< Class > &parent, bool includeSelf=true)

void	forallParents (const ClassVisitor &visitor, bool includeSelf=true, bool skipDuplicates=true)

void	forallChildren (const ClassTupleVisitor &visitor, bool skipDuplicates=true)

void	detach ()

	Class (std::string_view iri)

	Class (const IRIAtomPtr &iri)

void	addDirectParent (const std::shared_ptr< Class > &directParent, std::optional< std::string_view > graph)

void	removeDirectParent (const std::shared_ptr< Class > &directParent, std::optional< std::string_view > graph)

const auto &	directParents () const

bool	isDirectSubClassOf (const std::shared_ptr< Class > &directParent)

bool	isSubClassOf (const std::shared_ptr< Class > &parent, bool includeSelf=true)

void	forallParents (const ClassVisitor &visitor, bool includeSelf=true, bool skipDuplicates=true)

void	forallChildren (const ClassTupleVisitor &visitor, bool skipDuplicates=true)

void	detach ()

Public Member Functions inherited from knowrob::semweb::Resource
	Resource (std::string_view iri)

	Resource (const IRIAtomPtr &iri)

auto	iri () const

auto	iriAtom () const

std::string_view	name () const

std::string_view	ns (bool includeDelimiter=false) const

	Resource (std::string_view iri)

	Resource (const IRIAtomPtr &iri)

auto	iri () const

auto	iriAtom () const

std::string_view	name () const

std::string_view	ns (bool includeDelimiter=false) const

Protected Attributes
std::map< std::shared_ptr< Class >, std::set< AtomPtr, AtomComparator >, ClassComparator >	directParents_

std::set< std::shared_ptr< Class >, ClassComparator >	directChildren_

Protected Attributes inherited from knowrob::semweb::Resource
knowrob::AtomPtr	iri_

Additional Inherited Members
Static Public Member Functions inherited from knowrob::semweb::Resource
static IRIAtomPtr	unique_iri (std::string_view ns, std::string_view name)

static IRIAtomPtr	unique_iri (std::string_view type_iri)

static std::string_view	iri_name (std::string_view iri)

static std::string_view	iri_ns (std::string_view iri, bool includeDelimiter=false)

static AtomPtr	graph_atom (std::optional< std::string_view > graph)

static IRIAtomPtr	unique_iri (std::string_view ns, std::string_view name)

static IRIAtomPtr	unique_iri (std::string_view type_iri)

static std::string_view	iri_name (std::string_view iri)

static std::string_view	iri_ns (std::string_view iri, bool includeDelimiter=false)

static AtomPtr	graph_atom (std::optional< std::string_view > graph)

Detailed Description

A RDF class.

Definition at line 26 of file Class.h.

Constructor & Destructor Documentation

◆ Class() [1/4]

Class::Class ( std::string_view iri )

explicit

Parameters

iri	A class IRI.

Definition at line 15 of file Class.cpp.

16 : Resource(iri) {}

knowrob::semweb::Resource::iri

auto iri() const

Definition: Resource.h:26

knowrob::semweb::Resource::Resource

Resource(std::string_view iri)

Definition: Resource.cpp:23

◆ Class() [2/4]

Class::Class ( const IRIAtomPtr & iri )

explicit

Parameters

iri	A class IRI.

Definition at line 18 of file Class.cpp.

19 : Resource(iri) {}

◆ Class() [3/4]

knowrob::semweb::Class::Class ( std::string_view iri )

explicit

Parameters

iri	A class IRI.

◆ Class() [4/4]

knowrob::semweb::Class::Class ( const IRIAtomPtr & iri )

explicit

Parameters

iri	A class IRI.

Member Function Documentation

◆ addDirectParent() [1/2]

void Class::addDirectParent	(	const std::shared_ptr< Class > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super class.
graph	the graph where the relation is defined.

Definition at line 25 of file Class.cpp.

                                                                                                        {
     auto graphAtom = graph_atom(graph);
     auto pair = directParents_.find(directParent);
     if (pair != directParents_.end()) {
         // add origin to list
         pair->second.insert(graphAtom);
     } else {
         // add new entry
         directParents_[directParent].insert(graphAtom);
         directParent->directChildren_.insert(shared_from_this());
     }
 }

◆ addDirectParent() [2/2]

void knowrob::semweb::Class::addDirectParent	(	const std::shared_ptr< Class > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super class.
graph	the graph where the relation is defined.

◆ detach() [1/2]

void Class::detach ( )

Detach this class from its children and parents.

Definition at line 138 of file Class.cpp.

                    {
     directParents_.clear();
     directChildren_.clear();
 }

◆ detach() [2/2]

void knowrob::semweb::Class::detach ( )

Detach this class from its children and parents.

◆ directParents() [1/2]

const auto& knowrob::semweb::Class::directParents ( ) const

inline

Returns: all direct super classes of this class.

Definition at line 53 of file Class.h.

53 { return directParents_; }

◆ directParents() [2/2]

const auto& knowrob::semweb::Class::directParents ( ) const

inline

Returns: all direct super classes of this class.

Definition at line 53 of file Class.h.

53 { return directParents_; }

◆ forallChildren() [1/2]

void Class::forallChildren	(	const ClassTupleVisitor &	visitor,
		bool	skipDuplicates = `true`
	)

Parameters

visitor	a function that is called for each child in the class hierarchy.
skipDuplicates	if true, the method calls the visitor only once for each class.

Definition at line 113 of file Class.cpp.

                                                                                 {
     std::queue<std::pair<Class *, Class *>> queue_;
     std::set<std::string_view> visited_;
  
     // push initial elements to the queue
     for (auto &x: directChildren_) queue_.emplace(x.get(), this);
  
     // visit each child
     while (!queue_.empty()) {
         auto pair = queue_.front();
         auto front_child = pair.first;
         auto front_parent = pair.second;
         queue_.pop();
         // visit popped property
         visitor(*front_child, *front_parent);
         // remember visited nodes
         if (skipDuplicates) visited_.insert(front_child->iri());
         // push children of visited property on the queue
         for (auto &directChild: front_child->directChildren_) {
             if (skipDuplicates && visited_.count(directChild->iri()) > 0) continue;
             queue_.emplace(directChild.get(), front_child);
         }
     }
 }

◆ forallChildren() [2/2]

void knowrob::semweb::Class::forallChildren	(	const ClassTupleVisitor &	visitor,
		bool	skipDuplicates = `true`
	)

Parameters

visitor	a function that is called for each child in the class hierarchy.
skipDuplicates	if true, the method calls the visitor only once for each class.

◆ forallParents() [1/2]

void Class::forallParents	(	const ClassVisitor &	visitor,
		bool	includeSelf = `true`,
		bool	skipDuplicates = `true`
	)

Parameters

visitor	a function that is called for each parent in the class hierarchy.
includeSelf	if true, the method calls the visitor for this class.
skipDuplicates	if true, the method calls the visitor only once for each class.

Definition at line 87 of file Class.cpp.

                                                {
     std::queue<Class *> queue_;
     std::set<std::string_view> visited_;
  
     // push initial elements to the queue
     if (includeSelf) queue_.push(this);
     else for (auto &x: directParents_) queue_.push(x.first.get());
  
     // visit each parent
     while (!queue_.empty()) {
         auto front = queue_.front();
         queue_.pop();
         // visit popped property
         visitor(*front);
         // remember visited nodes
         if (skipDuplicates) visited_.insert(front->iri());
         // push parents of visited property on the queue
         for (auto &directParent: front->directParents_) {
             if (skipDuplicates && visited_.count(directParent.first->iri()) > 0) continue;
             queue_.push(directParent.first.get());
         }
     }
 }

◆ forallParents() [2/2]

void knowrob::semweb::Class::forallParents	(	const ClassVisitor &	visitor,
		bool	includeSelf = `true`,
		bool	skipDuplicates = `true`
	)

Parameters

visitor	a function that is called for each parent in the class hierarchy.
includeSelf	if true, the method calls the visitor for this class.
skipDuplicates	if true, the method calls the visitor only once for each class.

◆ isDirectSubClassOf() [1/2]

bool Class::isDirectSubClassOf ( const std::shared_ptr< Class > & directParent )

Parameters

directParent a direct super class.

Returns: true if directParent is a direct super class of this class.

Definition at line 57 of file Class.cpp.

                                                                        {
     return directParents_.count(directParent) > 0;
 }

◆ isDirectSubClassOf() [2/2]

bool knowrob::semweb::Class::isDirectSubClassOf ( const std::shared_ptr< Class > & directParent )

Parameters

directParent a direct super class.

Returns: true if directParent is a direct super class of this class.

◆ isSubClassOf() [1/2]

bool Class::isSubClassOf	(	const std::shared_ptr< Class > &	parent,
		bool	includeSelf = `true`
	)

Parameters

parent	a super class.
includeSelf	if true, the method returns true if this class is the same

Returns: true if this class is a sub class of parent.

Definition at line 61 of file Class.cpp.

                                                                              {
     std::queue<Class *> queue_;
     std::set<std::string_view> visited_;
  
     if (includeSelf && this == parent.get()) return true;
     queue_.push(this);
  
     // visit each parent
     while (!queue_.empty()) {
         auto front = queue_.front();
         queue_.pop();
  
         // visit popped property
         if (front->directParents_.count(parent) > 0) return true;
         // remember visited nodes
         visited_.insert(front->iri());
         // push parents of visited property on the queue
         for (auto &directParent: front->directParents_) {
             if (visited_.count(directParent.first->iri()) > 0) continue;
             queue_.push(directParent.first.get());
         }
     }
  
     return false;
 }

◆ isSubClassOf() [2/2]

bool knowrob::semweb::Class::isSubClassOf	(	const std::shared_ptr< Class > &	parent,
		bool	includeSelf = `true`
	)

Parameters

parent	a super class.
includeSelf	if true, the method returns true if this class is the same

Returns: true if this class is a sub class of parent.

◆ removeDirectParent() [1/2]

void Class::removeDirectParent	(	const std::shared_ptr< Class > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super class.
graph	the graph where the relation is defined.

Definition at line 38 of file Class.cpp.

                                                                                                           {
     auto pair = directParents_.find(directParent);
     if (pair != directParents_.end()) {
         // remove origin from list
         std::string_view v_graph = (graph) ? graph.value() : ImportHierarchy::ORIGIN_SESSION;
         for (auto it = pair->second.begin(); it != pair->second.end(); it++) {
             if ((*it)->stringForm() == v_graph) {
                 pair->second.erase(it);
                 break;
             }
         }
         // remove if no origin is left
         if (pair->second.empty()) {
             directParents_.erase(pair);
             directParent->directChildren_.erase(shared_from_this());
         }
     }
 }

◆ removeDirectParent() [2/2]

void knowrob::semweb::Class::removeDirectParent	(	const std::shared_ptr< Class > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super class.
graph	the graph where the relation is defined.

Member Data Documentation

◆ directChildren_

std::set< std::shared_ptr< Class >, ClassComparator > knowrob::semweb::Class::directChildren_

protected

Definition at line 94 of file Class.h.

◆ directParents_

std::map< std::shared_ptr< Class >, std::set< AtomPtr, AtomComparator >, ClassComparator > knowrob::semweb::Class::directParents_

protected

Definition at line 93 of file Class.h.

The documentation for this class was generated from the following files:

build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/semweb/Class.h
src/semweb/Class.cpp

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Class() [1/4]

◆ Class() [2/4]

◆ Class() [3/4]

◆ Class() [4/4]

Member Function Documentation

◆ addDirectParent() [1/2]

◆ addDirectParent() [2/2]

◆ detach() [1/2]

◆ detach() [2/2]

◆ directParents() [1/2]

◆ directParents() [2/2]

◆ forallChildren() [1/2]

◆ forallChildren() [2/2]

◆ forallParents() [1/2]

◆ forallParents() [2/2]

◆ isDirectSubClassOf() [1/2]

◆ isDirectSubClassOf() [2/2]

◆ isSubClassOf() [1/2]

◆ isSubClassOf() [2/2]

◆ removeDirectParent() [1/2]

◆ removeDirectParent() [2/2]

Member Data Documentation

◆ directChildren_

◆ directParents_