~robot3d-team/robot3d/trunk

« back to all changes in this revision

Viewing changes to inc/srInterface/YarpPlugin.h

  • Committer: Anne van Rossum
  • Date: 2010-08-10 15:58:55 UTC
  • Revision ID: anne@gamix-20100810155855-kve7x2vwouagdij9
Initial import

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/**
 
2
 * @file YarpPlugin.h
 
3
 *
 
4
 * This file YarpPlugin.h is created at Almende B.V. It is open-source software and part
 
5
 * of the Common Hybrid Agent Platform (CHAP). A toolbox with a lot of open-source tools.
 
6
 * Ranging from thread pools, and TCP/IP components to control architectures and learning
 
7
 * algorithms. This software is published under the GNU Lesser General Public license,
 
8
 *
 
9
 * It is not possible to add usage restrictions to an open-source license. Nevertheless,
 
10
 * we personally strongly object against this software used by the military, in the
 
11
 * bio-industry, for animal experimentation, or anything that violates the Universal
 
12
 * Declaration of Human Rights.
 
13
 *
 
14
 * @author      Anne C. van Rossum
 
15
 * @date        Aug 4, 2010
 
16
 * @project     Replicator FP7
 
17
 * @company     Almende B.V.
 
18
 * @case        
 
19
 */
 
20
 
 
21
 
 
22
#ifndef YARPPLUGIN_H_
 
23
#define YARPPLUGIN_H_
 
24
 
 
25
// General files
 
26
 
 
27
// Robot3D files
 
28
#include <srCore/pluginEntryPointBase.h>
 
29
#include <srCore/singleton.h>
 
30
#include <srInterface/YarpedSim.h>
 
31
 
 
32
namespace srInterface {
 
33
 
 
34
/* **************************************************************************************
 
35
 * Interface of YarpPlugin
 
36
 * **************************************************************************************/
 
37
 
 
38
 
 
39
class YarpPlugin: public srCore::PluginEntryPointBase {
 
40
public:
 
41
        /**
 
42
         * Constructor YarpPlugin
 
43
         */
 
44
        YarpPlugin();
 
45
 
 
46
        /**
 
47
         * Destructor ~YarpPlugin
 
48
         */
 
49
        virtual ~YarpPlugin();
 
50
 
 
51
        /// The to-be-overloaded function called from Robot3D
 
52
        virtual void StartPlugin(dtGame::GameApplication &application);
 
53
 
 
54
protected:
 
55
 
 
56
private:
 
57
        YarpedSim *yarped_sim;
 
58
};
 
59
 
 
60
}
 
61
 
 
62
/**
 
63
 * YarpPluginSingleton, this is the class definition that can be used. Use it by
 
64
 * YarpPluginSingleton::Instance().
 
65
 */
 
66
typedef srCore::Singleton<srInterface::YarpPlugin> YarpPluginSingleton;
 
67
 
 
68
 
 
69
#endif /* YARPPLUGIN_H_ */