Fawkes API Fawkes Development Version
edge_constraint.h
1/***************************************************************************
2 * edge_constraint.h - base class for edge constraints
3 *
4 * Created: Sat Jul 12 14:40:01 2014
5 * Copyright 2014 Sebastian Reuter
6 * 2014 Tim Niemueller
7 ****************************************************************************/
8
9/* This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Library General Public License for more details.
18 *
19 * Read the full text in the LICENSE.GPL file in the doc directory.
20 */
21
22#ifndef _NAVGRAPH_CONSTRAINTS_EDGE_CONSTRAINT_H_
23#define _NAVGRAPH_CONSTRAINTS_EDGE_CONSTRAINT_H_
24
25#include <navgraph/navgraph_node.h>
26
27#include <string>
28#include <vector>
29
30namespace fawkes {
31
32class Logger;
33
35{
36public:
37 NavGraphEdgeConstraint(const std::string &name);
38 NavGraphEdgeConstraint(const char *name);
40
41 std::string name();
42
43 virtual bool compute(void) noexcept;
44 virtual bool blocks(const fawkes::NavGraphNode &from,
45 const fawkes::NavGraphNode &to) noexcept = 0;
46
47 bool operator==(const std::string &name) const;
48
49protected:
50 std::string name_;
51};
52
53} // end namespace fawkes
54
55#endif
Constraint that can be queried to check if an edge is blocked.
std::string name_
Name of constraint.
NavGraphEdgeConstraint(const std::string &name)
Constructor.
virtual bool blocks(const fawkes::NavGraphNode &from, const fawkes::NavGraphNode &to) noexcept=0
Check if constraint blocks an edge.
bool operator==(const std::string &name) const
Check if constraint matches name.
virtual bool compute(void) noexcept
Perform compuations before graph search and to indicate re-planning.
virtual ~NavGraphEdgeConstraint()
Virtual empty destructor.
std::string name()
Get name of constraint.
Topological graph node.
Definition: navgraph_node.h:36
Fawkes library namespace.