Fawkes API  Fawkes Development Version
gossip.cpp
1 
2 /***************************************************************************
3  * gossip.cpp - Robot Group Communication Aspect
4  *
5  * Created: Fri Feb 28 16:47:24 2014
6  * Copyright 2006-2014 Tim Niemueller [www.niemueller.de]
7  *
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. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #include <plugins/gossip/aspect/gossip.h>
25 #include <plugins/gossip/gossip/gossip_group.h>
26 
27 namespace fawkes {
28 
29 /** @class GossipAspect <plugins/gossip/aspect/gossip.h>
30  * Thread aspect to communicate with a group of robots.
31  * Give this aspect to your thread to get access to a communication
32  * group.
33  *
34  * @ingroup Aspects
35  * @author Tim Niemueller
36  */
37 
38 /** @var fawkes:RefPtr<GossipGroup> GossipAspect::gossip_group
39  * Gossip group to communicate with other robots.
40  */
41 
42 /** Constructor.
43  * @param group_name Gossip group to join and communicate with.
44  */
45 GossipAspect::GossipAspect(const char *group_name) : GossipAspect_group_name_(group_name)
46 {
47  add_aspect("GossipAspect");
48 }
49 
50 /** Virtual empty destructor. */
52 {
53 }
54 
55 } // end namespace fawkes
fawkes::Aspect::add_aspect
void add_aspect(const char *name)
Add an aspect to a thread.
Definition: aspect.cpp:49
fawkes::GossipAspect::~GossipAspect
virtual ~GossipAspect()
Virtual empty destructor.
Definition: gossip.cpp:51
fawkes
Fawkes library namespace.
fawkes::GossipAspect::GossipAspect
GossipAspect(const char *group_name)
Constructor.
Definition: gossip.cpp:45