ymlnetwork.h

Go to the documentation of this file.

/*******************************************************************\

                   SESAME project software license

              Copyright (C) 2002 University of Amsterdam

    This program is free software; you can redistribute it and/or
     modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
        of the License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
                           02111-1307, USA.

      For information regarding the SESAME software project see
              http://sesamesim.sourceforge.net or email
                    jcofflan@users.sourceforge.net

\*******************************************************************/
#ifndef YMLNETWORK_H
#define YMLNETWORK_H

#include <map>
#include <list>

#include <BasicUtils/BasicArray.h>

#include "ymlnode.h"

class YMLLink;
class YMLEntityFactory;
class YMLConnection;
class TraceContext;

#ifndef LTSTR
#define LTSTR
#include <string.h>
struct ltstr {
  bool operator()(const char* s1, const char* s2) const {
    return strcmp(s1, s2) < 0;
  }
};
#endif

typedef std::list<YMLNode *> node_list_t;

// YMLNode
class YMLNetwork: public YMLNode {
  std::map<const char *, YMLNode *, ltstr> node_map;
  BasicArray<YMLLink *> links;
  BasicArray<YMLNode *> nodes;
  BasicArray<YMLConnection *> connections;

  TraceContext *traceContext;

 public:
  YMLNetwork();
  virtual ~YMLNetwork();

  // Link operations
  void addLink(YMLLink *link) {links.put(link);}
  int getNumLinks() {return links.getSize();}
  YMLLink *getLink(int i) {return links[i];}

  // Node operations
  void addNode(YMLNode *node);
  YMLNode *findNode(const char *name) {return node_map[name];}
  int getNumNodes() {return nodes.getSize();}
  YMLNode *getNode(int i) {return nodes[i];}
  void collectAllNodes(node_list_t &list);

  // Connection operations
  int getNumConnections() {return connections.getSize();}
  YMLConnection *getConnection(int i) {return connections[i];}
  bool connect();
  void createDirectConnections(YMLEntityFactory *factory, YMLPort *source,
                               YMLPortSide *side, int commChannelID);
  void createDirectConnections(YMLEntityFactory *factory);

  void setTraceContext(TraceContext *traceContext)
  {this->traceContext = traceContext;}
  TraceContext *getTraceContext() {return traceContext;}


  // XML operations
  virtual void dumpXML(XMLSerializer &stream);
  void dumpXMLLinks(XMLSerializer &stream);
  void dumpXMLNodes(XMLSerializer &stream);

  // DOT operations
  virtual void dumpDOT(std::ostream &stream, int tabLevel, bool flat = false);
  void dumpDOTConnections(std::ostream &stream, int tabLevel,
                          bool flat = false);
  void dumpDOTNodes(std::ostream &stream, int tabLevel);
  void dumpDOTSubNets(std::ostream &stream, int tabLevel, bool flat = false);
  void dumpDOTSubNet(std::ostream &stream, int tabLevel, bool flat = false);

  // Finalize operations
  void doFinalizeNodes();
  void doFinalizeLinks();
  void doFinalize();

  ymlentity_t getType() {return ymlNetwork;}

 private:
  YMLPortSide *getPortSide(const char *nodeName, const char *portName);
};

#endif

---