Fawkes API  Fawkes Development Version
static_list_node_constraint.h
1 /***************************************************************************
2  * static_list_node_constraint.h - node constraint that holds a static list
3  * of nodes to block
4  *
5  * Created: Sun Mar 02 10:47:35 2014
6  * Copyright 2014 Sebastian Reuter
7  * 2014 Tim Niemueller
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Library General Public License for more details.
19  *
20  * Read the full text in the LICENSE.GPL file in the doc directory.
21  */
22 
23 #ifndef __NAVGRAPH_CONSTRAINTS_STATIC_LIST_NODE_CONSTRAINT_H_
24 #define __NAVGRAPH_CONSTRAINTS_STATIC_LIST_NODE_CONSTRAINT_H_
25 
26 #include <navgraph/constraints/node_constraint.h>
27 
28 #include <vector>
29 #include <string>
30 
31 #include <navgraph/navgraph.h>
32 
33 namespace fawkes{
34 #if 0 /* just to make Emacs auto-indent happy */
35 }
36 #endif
37 
39 {
40  public:
42 
43  NavGraphStaticListNodeConstraint(std::string name,
44  std::vector<fawkes::NavGraphNode> &node_list);
45 
47 
48  const std::vector<fawkes::NavGraphNode> & node_list() const;
49 
50  void add_node(const fawkes::NavGraphNode &node);
51  void add_nodes(const std::vector<fawkes::NavGraphNode> &nodes);
52  void remove_node(const fawkes::NavGraphNode &node);
53  void clear_nodes();
54  bool has_node(const fawkes::NavGraphNode &node);
55 
56  virtual bool compute(void) throw();
57 
58  virtual bool blocks(const fawkes::NavGraphNode &node) throw()
59  { return has_node(node); }
60 
61  protected:
62  std::vector<fawkes::NavGraphNode> node_list_; ///< Node list
63  bool modified_; ///< Set to true if changes are made to the constraint.
64 
65 };
66 
67 } // end namespace fawkes
68 
69 #endif
Fawkes library namespace.
std::string name()
Get name of constraint.
void add_node(const fawkes::NavGraphNode &node)
Add a single node to constraint list.
std::vector< fawkes::NavGraphNode > node_list_
Node list.
void remove_node(const fawkes::NavGraphNode &node)
Remove a single node from the constraint list.
const std::vector< fawkes::NavGraphNode > & node_list() const
Get list of blocked nodes.
bool has_node(const fawkes::NavGraphNode &node)
Check if constraint has a specific node.
void add_nodes(const std::vector< fawkes::NavGraphNode > &nodes)
Add multiple nodes to constraint list.
Topological graph node.
Definition: navgraph_node.h:38
virtual bool blocks(const fawkes::NavGraphNode &node)
Check if constraint blocks a node.
NavGraphStaticListNodeConstraint(std::string name)
Constructor.
Constraint that holds a list of nodes to block.
bool modified_
Set to true if changes are made to the constraint.
Constraint that can be queried to check if a node is blocked.
virtual ~NavGraphStaticListNodeConstraint()
Virtual empty destructor.
virtual bool compute(void)
Perform compuations before graph search and to indicate re-planning.