nedtypeinfo.h

Go to the documentation of this file.

//==========================================================================
// NEDTYPEINFO.H -
//
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 2002-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/


#ifndef __NEDTYPEINFO_H
#define __NEDTYPEINFO_H

#include <map>
#include <vector>
#include <string>
#include "nedelements.h"
#include "commonutil.h"

NAMESPACE_BEGIN

class NEDResourceCache;

class NEDXML_API NEDTypeInfo
{
  public:
    enum Type {SIMPLE_MODULE, COMPOUND_MODULE, MODULEINTERFACE, CHANNEL, CHANNELINTERFACE};

  protected:
    // the resolver this type is in
    NEDResourceCache *resolver;

    Type type;
    std::string qualifiedName;
    bool isInner;  // whether it is an inner type
    NEDElement *tree; // points into resolver

    typedef std::vector<std::string> StringVector;
    typedef std::map<std::string,int> StringToIntMap;

    // inheritance. Vectors contain fully qualifies names, and include
    // indirect base types/interfaces as well (transitive closure).
    StringVector extendsnames;
    StringVector interfacenames;

    std::string enclosingTypeName;

    // simple module/channel C++ class to instantiate
    std::string implClassName;

  protected:
    void checkComplianceToInterface(NEDTypeInfo *interfaceDecl);

  public:
    NEDTypeInfo(NEDResourceCache *resolver, const char *qname, bool isInnerType, NEDElement *tree);

    virtual ~NEDTypeInfo();

    virtual const char *getName() const;

    virtual const char *getFullName() const;

    virtual NEDElement *getTree() const;

    NEDResourceCache *getResolver() const  {return resolver;}

    virtual Type getType() const {return type;}

    virtual std::string getPackage() const;

    virtual std::string info() const;

    virtual std::string nedSource() const;

    virtual int numExtendsNames() const  {return extendsnames.size();}

    virtual const char *extendsName(int k) const;

    virtual int numInterfaceNames() const  {return interfacenames.size();}

    virtual const char *interfaceName(int k) const;

    virtual bool supportsInterface(const char *qname);

    virtual bool isInnerType() const  {return isInner;}

    virtual const char *getEnclosingTypeName() const;

    virtual bool isNetwork() const;

    virtual const char *getImplementationClassName() const;

    virtual std::string getPackageProperty(const char *name) const;

    virtual std::string getCxxNamespace() const;

    virtual NEDTypeInfo *getSuperDecl() const;

    ParametersElement *getParametersElement() const;
    GatesElement *getGatesElement() const;
    SubmodulesElement *getSubmodulesElement() const;
    ConnectionsElement *getConnectionsElement() const;

    SubmoduleElement *getLocalSubmoduleElement(const char *submoduleName) const;

    ConnectionElement *getLocalConnectionElement(long id) const;

    SubmoduleElement *getSubmoduleElement(const char *submoduleName) const;

    ConnectionElement *getConnectionElement(long id) const;

    ParamElement *findLocalParamDecl(const char *name) const;

    ParamElement *findParamDecl(const char *name) const;

    GateElement *findLocalGateDecl(const char *name) const;

    GateElement *findGateDecl(const char *name) const;
};

NAMESPACE_END


#endif