PKFinder.h
Go to the documentation of this file.
1
#pragma once
2
3
#include <
ArmarXCore/core/application/properties/PropertyDefinitionContainer.h
>
4
5
#include <
RobotAPI/libraries/PriorKnowledge/core/FinderBase.h
>
6
#include <
RobotAPI/libraries/PriorKnowledge/core/FinderInfoBase.h
>
7
8
namespace
armarx::priorknowledge::core
9
{
10
/**
11
* @brief The ObjectFinderInfo class
12
* Specialization of the DatasetFinderInfo with strings as dataset and id types
13
*/
14
class
PKFinderInfo
:
public
core::FinderInfoBase
<std::string>
15
{
16
using
Base
=
core::FinderInfoBase<std::string>
;
17
18
public
:
19
using
Base::Base;
20
};
21
22
/**
23
* @brief The ObjectFinder class
24
*/
25
class
PKFinder
:
public
core::FinderBase
<std::string, PKFinderInfo>
26
{
27
using
Base
=
core::FinderBase<std::string, PKFinderInfo>
;
28
29
public
:
30
static
const
constexpr
auto
DEFAULT_PACKAGE
=
"PriorKnowledgeData"
;
31
32
using
Base::Base;
33
34
PKFinder
(
const
std::filesystem::path& relDir) :
Base
(
DEFAULT_PACKAGE
, relDir)
35
{
36
}
37
38
virtual
~PKFinder
()
39
{
40
}
41
42
virtual
void
init
();
43
virtual
void
registerPropertyDefinitions
(
armarx::PropertyDefinitionsPtr
& defs,
44
const
std::string& prefix);
45
46
bool
checkAll
()
const override
;
47
48
bool
check
(
const
std::string&
id
)
const override
;
49
50
std::optional<PKFinderInfo>
find
(
const
std::string&
id
)
const override
;
51
52
std::vector<PKFinderInfo>
findAll
()
const override
;
53
54
private
:
55
std::vector<std::string> ID_BLACKLIST = {
"script"
};
56
};
57
58
}
// namespace armarx::priorknowledge::core
armarx::priorknowledge::core::PKFinder::checkAll
bool checkAll() const override
Definition:
PKFinder.cpp:30
armarx::priorknowledge::core::FinderBase
Definition:
FinderBase.h:19
armarx::priorknowledge::core::PKFinder::find
std::optional< PKFinderInfo > find(const std::string &id) const override
Definition:
PKFinder.cpp:69
armarx::priorknowledge::core::PKFinder
The ObjectFinder class.
Definition:
PKFinder.h:25
armarx::priorknowledge::core::PKFinder::registerPropertyDefinitions
virtual void registerPropertyDefinitions(armarx::PropertyDefinitionsPtr &defs, const std::string &prefix)
Definition:
PKFinder.cpp:12
FinderInfoBase.h
armarx::priorknowledge::core::PKFinder::check
bool check(const std::string &id) const override
Definition:
PKFinder.cpp:56
FinderBase.h
armarx::priorknowledge::core::PKFinder::init
virtual void init()
Definition:
PKFinder.cpp:24
armarx::priorknowledge::core::PKFinder::findAll
std::vector< PKFinderInfo > findAll() const override
Definition:
PKFinder.cpp:82
armarx::priorknowledge::core::PKFinder::PKFinder
PKFinder(const std::filesystem::path &relDir)
Definition:
PKFinder.h:34
armarx::priorknowledge::core::PKFinderInfo
The ObjectFinderInfo class Specialization of the DatasetFinderInfo with strings as dataset and id typ...
Definition:
PKFinder.h:14
armarx::priorknowledge::core::PKFinder::~PKFinder
virtual ~PKFinder()
Definition:
PKFinder.h:38
PropertyDefinitionContainer.h
IceUtil::Handle< class PropertyDefinitionContainer >
armarx::priorknowledge::core
Definition:
FinderBase.h:16
armarx::priorknowledge::core::FinderInfoBase
The FinderInfoBase class Indicates an into to 'something' of type IDType.
Definition:
FinderInfoBase.h:34
armarx::priorknowledge::core::PKFinder::DEFAULT_PACKAGE
static const constexpr auto DEFAULT_PACKAGE
Definition:
PKFinder.h:30
RobotAPI
libraries
PriorKnowledge
core
PKFinder.h
Generated on Sat Sep 7 2024 09:13:55 for armarx_documentation by
1.8.17