IRigidModelProvider.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.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * 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_IRIGIDMODELPROVIDER_H_
#define _MIRA_IRIGIDMODELPROVIDER_H_

#include <serialization/IgnoreMissing.h>

#include <fw/Framework.h>
#include <fw/ServiceProperty.h>

#include <model/RigidModel.h>

namespace mira { namespace model {


Buffer<uint8> findAndLoadResourceFile(const std::string& filename,
                                      bool compress, uint32 maxFileSize);


class IRigidModelProvider
{
public:

    IRigidModelProvider() : mServiceRegistered(false) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
    }

    void reflect(RPCServer::RPCReflector& r) {
        // only register once, even when called twice (diamond class structure)
        if (mServiceRegistered)
            return;

        r.interface("IRigidModelProvider");
        r.method("getRigidModel", &IRigidModelProvider::getRigidModel, this,
                 "Return the current rigid model");

        r.interface("IResourceFileProvider");
        r.property("MaxTransferFileSize", mMaxFileSize,
                   "Max size of files to transfer", std::numeric_limits<uint32>::max());
        r.method("getResourceFile", &IRigidModelProvider::getResourceFile, this,
                 "Return a buffer containing the content of a resource file",
                 "filename", "The file's filename", "MyModel.mesh",
                 "compress", "Whether to compress the returned buffer", true);

        mServiceRegistered = true;
    }

    virtual ~IRigidModelProvider() {}

    virtual model::RigidModelPtr getRigidModel() = 0;

    virtual Buffer<uint8> getResourceFile(const std::string& filename, bool compress) {
        return findAndLoadResourceFile(filename, compress, mMaxFileSize);
    }

private:
    bool mServiceRegistered;

    uint32 mMaxFileSize;
};


class IRigidModelConsumer
{
public:

    // Subclasses should set mModelProvider themselves if they expect a different
    // (derived) interface
    IRigidModelConsumer() : mModelProvider("IRigidModelProvider") {}
    virtual ~IRigidModelConsumer() {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.property("ModelProvider", mModelProvider,
                   setter(&IRigidModelConsumer::setModelProvider, this),
                   "The name of the service that provides a rigid model "
                   "(if empty, a suitable service should be chosen automatically)",
                   serialization::IgnoreMissing());

        r.method("getModelProviderChannel",
                 &IRigidModelConsumer::getModelProviderChannel, this,
                 "Query channel where the service publishes changes of ModelProvider.");

        r.interface("IRigidModelConsumer");
    }

    void setModelProvider(ServiceProperty service);

    virtual std::string getModelProviderChannel();

protected:

    void initialize();

    virtual void setModelProviderInternal(ServiceProperty service) = 0;

    virtual Authority* getAuthority() = 0;

    virtual std::string getModelProviderChannelInternal();

protected:
    ServiceProperty mModelProvider;

    Channel<std::string> mModelProviderChannel;
};


}}

#endif