port.h

Go to the documentation of this file.

#ifndef PORT_H
#define PORT_H
 
#include <string>
#include <vector>
#include <set>
#include <deque>
#include <ostream>
#include <memory>
 
#include <vistle/util/enum.h>
#include "export.h"
 
namespace vistle {
 
class Object;
typedef std::shared_ptr<const Object> obj_const_ptr;
typedef std::deque<obj_const_ptr> ObjectList;
 
namespace detail {
 
template<class T>
struct deref_compare {
    bool operator()(const T *x, const T *y) const { return *x < *y; }
};
 
} // namespace detail
 
class V_COREEXPORT Port {
    friend class PortTracker;
 
public:
    DEFINE_ENUM_WITH_STRING_CONVERSIONS(Type, (ANY)(INPUT)(OUTPUT)(PARAMETER))
    DEFINE_ENUM_WITH_STRING_CONVERSIONS(
        Flags,
        (NONE)(NOCOMPUTE) //< compute won't be called for objects received via this port
        (COMBINE_BIT) //< several connections to a single port are allowed and should be processed together - only together with NOCOMPUTE
        (COMBINE) //< several connections to a single port are allowed and should be processed together
        (MULTI) //< additional ports are created for each connected port
    )
 
    Port(int moduleID, const std::string &name, Port::Type type, int flags = 0);
    void setDescription(const std::string &desc);
    int getModuleID() const;
    const std::string &getName() const;
    const std::string &getDescription() const;
    Type getType() const;
    int flags() const;
 
    ObjectList &objects();
    const ObjectList &objects() const;
 
    typedef std::set<Port *, detail::deref_compare<Port>> PortSet;
    typedef std::set<const Port *, detail::deref_compare<Port>> ConstPortSet;
    const ConstPortSet &connections() const;
    void setConnections(const ConstPortSet &conn);
    bool addConnection(Port *other);
    const Port *removeConnection(const Port &other);
    bool isConnected() const;
 
    const PortSet &linkedPorts() const;
 
    bool operator<(const Port &other) const
    {
        if (getModuleID() == other.getModuleID()) {
            return getName() < other.getName();
        }
        return getModuleID() < other.getModuleID();
    }
    bool operator==(const Port &other) const
    {
        return getModuleID() == other.getModuleID() && getName() == other.getName();
    }
 
    Port *child(size_t idx, bool link = false);
    bool link(Port *linked);
 
private:
    int moduleID;
    std::string name;
    std::string description;
    Type type;
    int m_flags;
    ObjectList m_objects;
    ConstPortSet m_connections;
    Port *m_parent;
    std::vector<Port *> m_children;
    PortSet m_linkedPorts;
};
 
V_COREEXPORT std::ostream &operator<<(std::ostream &s, const Port &port);
 
V_ENUM_OUTPUT_OP(Type, Port)
V_ENUM_OUTPUT_OP(Flags, Port)
 
} // namespace vistle
#endif