~robot3d-team/robot3d/trunk

/*

 * File: YarpedSim.h

 */

 

/* 

 * This file YarpedSim.h is created at Almende B.V. It is open-source software and part

 * of the Common Hybrid Agent Platform (CHAP). A toolbox with a lot of open-source tools.

 * Ranging from thread pools, and TCP/IP components to control architectures and learning

 * algorithms. This software is published under the GNU Lesser General Public license,

 *

 * It is not possible to add usage restrictions to an open-source license. Nevertheless,

 * we personally strongly object against this software used by the military, in the

 * bio-industry, for animal experimentation, or anything that violates the Universal

 * Declaration of Human Rights.

 *

 * Author:      Anne C. van Rossum

 * Date:        Aug 2, 2010

 * Project:     Replicator FP7

 * Company:     Almende B.V.

 * Case:        

 */

 

 

#ifndef YARPEDSIM_H_

#define YARPEDSIM_H_

 

// General files

#include <string>

 

// Delta3D files

#include <dtGame/gmcomponent.h>

 

// YARP files

#include <yarp/os/BufferedPort.h>

#include <yarp/os/Bottle.h>

#include <yarp/os/Vocab.h>

#include <yarp/os/Network.h>

 

// Robot3D files

#include <srInterface/YarpUtil.h>

 

using namespace yarp::os;

 

namespace srInterface {

 

typedef struct Vec3 {

    float x;

    float y;

    float z;

} Vec3f;

 

/* **************************************************************************************

 * Interface of YarpedSim

 * **************************************************************************************/

 

/*

 * The simulator can be interfaced over YARP via this class. It makes it possible to add

 * and remove robots. It is a Delta3D component and a YARP module at once. The first parent

 * class describes a ProcessMessage routine that needs to be implemented to receive game

 * messages. The latter defines runModule, updateModule, etc. This leads to conflicts: which

 * entity should be able to tick YarpedSim? We choose to call updateModule from the

 * ProcessMessage routine ourselves. So, runModule will not be called at all.

 */

class YarpedSim: public dtGame::GMComponent {

public:

        /*

         * Function: YarpedSim

         */

        YarpedSim();

 

        /*

         * Function: ~YarpedSim

         */

        virtual ~YarpedSim();

 

        /*

         * Function: ProcessMessage ticks

         */

        void ProcessMessage(const dtGame::Message &message);

 

        /**

         * Get AddRobot information from bottle

         */

        bool ReadBottleAddRobot(Bottle &bottle, std::string &name, std::string &type,

                        int &id, osg::Vec3f &position);

protected:

 

        // Add robot

        void AddRobot(const std::string &name, const std::string &type, const int &id, const osg::Vec3f &position);

 

private:

        // Global port for YARP commands to Robot3D

        BufferedPort<Bottle> globalYarpPort;

 

        //Reference to YARP will be created when this object is created

        Network network;

};

 

}

 

#endif /* YARPEDSIM_H_ */