Module.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 *  and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Redistribution and modification of this code is strictly prohibited.
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_PILOT_MODULE_H_
#define _MIRA_PILOT_MODULE_H_

#include <factory/Factory.h>
#include <fw/Framework.h>

namespace mira { namespace pilot {

class Pilot;

class Module : public Object, public Authority
{
MIRA_OBJECT(Module);
public:

    Module();
    virtual ~Module();
    
    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member("ItemName", mItemName,
                 "An optional name that can be used to identify this item, e.g."
                 "when displayed in property editor (default=class name)",
                 this->getClass().getName());
    }

    void pauseModule();
    void resumeModule();

public:

    void initialize(Pilot* pilot);
    virtual void initialize() {}
    virtual void pause() {}
    virtual void resume() {}

    Pilot* getPilot() { return mPilot; }
    const std::string& getItemName() const { return mItemName; }

private:
    Pilot* mPilot;
    std::string mItemName;
};


} } // namespace

#endif