Info.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of CCA project
 *
 * Copyright (C) 2011 by Arne Nordmann <anordman at cor-lab dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <iostream>

#include <boost/shared_ptr.hpp>

#include <rsc/runtime/Properties.h>

#include "cca/buffer/Buffer.h"
#include "cca/port/InputPort.h"
#include "cca/port/OutputPort.h"
#include "cca/port/PortConfiguration.h"
#include "cca/ProcessingStrategy.h"

#include "cca/dto/DataTransferObject.h"
#include "cca/component/State.h"
#include "cca/timing/Tick.h"

namespace cca {

class ComponentInfo;
typedef ::boost::shared_ptr<ComponentInfo> ComponentInfoPtr;

class ComponentInfo: public DataTransferObject {

public:

    typedef std::pair<std::string, InputPortPtr> NamedInputPort;
    typedef std::pair<std::string, OutputPortPtr> NamedOutputPort;
    typedef std::map<std::string, InputPortPtr> NamedInputPorts;
    typedef std::map<std::string, OutputPortPtr> NamedOutputPorts;

    ComponentInfo(const std::string &name);

    virtual ~ComponentInfo();

    virtual std::string print() const;

    void displayStrategy(StrategyPtr strategy);

    void displayDataPorts(NamedInputPorts inputPorts,
            NamedOutputPorts outputPorts);

    void displayStatePorts(InputPort<ComponentState>::Ptr inputPort,
            OutputPort<ComponentState>::Ptr outputPort);

    void displayBeatPort(InputPort<cca::timing::Tick>::Ptr inputPort);

    void displayComponentState(ComponentStatePtr state);

    void displayProperties(const rsc::runtime::Properties& d,
            const rsc::runtime::Properties& p);

    std::string name;
    std::string stateCache;
    std::string strategyCache;
    std::string dataPortsCache, statePortsCache, beatPortsCache;
    std::string propertiesCache;

protected:
    virtual std::string line(std::string str, unsigned int place = 0,
            bool horizontal = false) const;
};

}