ymlport.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 YMLPORT_H
#define YMLPORT_H

#include "ymlentity.h"
#include "ymlportside.h"

#include <BasicUtils/BasicArray.h>

#include <string>

class YMLNode;
class YMLEntityFactory;
class YMLPortSide;
class YMLConnection;

class YMLPort: public YMLEntity {
 public:
  static const int aName = 0;
  static const int aDir = 1;
  typedef enum {dUnknown = -1, dIn, dOut} dir_t;
 private:

  YMLNode *parent;

  dir_t dir;

  YMLPortSide inSide;

  YMLPortSide outSide;

  BasicArray<YMLConnection *> connections;

  int id;

public:
  YMLPort();

  const char *getName() {return getArg(aName);}
  void dumpFullName(std::ostream &stream);
  std::string getFullName();

  dir_t getDir() {if (dir == dUnknown) resolveDir(); return dir;}

  YMLNode *getParent() {return parent;}

  void setParent(YMLNode *parent) {this->parent = parent;}

  YMLPortSide *getInSide() {return &inSide;}

  YMLPortSide *getOutSide() {return &outSide;}


  YMLPort *getRemotePort();
  void getRemotePorts(BasicArray<YMLPort *> &ports);

  void addConnection(YMLConnection *con) {connections.put(con);}
  YMLConnection *getConnection();
  const BasicArray<YMLConnection *> &getConnections() {return connections;}

  void setID(int id);
  int getID();

  virtual void dumpXML(XMLSerializer &stream);

  virtual void doFinalize() {finalize();}

  ymlentity_t getType() {return ymlPort;}

 protected:
  YMLPort *getRemotePort(YMLConnection *connection);
  void resolveDir();
};
#endif

---