STK_IStep.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  Serge Iovleff

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser 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 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser 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

 Contact : Serge.Iovleff@stkpp.org
 */
/*--------------------------------------------------------------------*/
/* $Id: STK_IStep.h,v 1.4 2009/10/26 22:08:01 siovleff Exp $
 *
 * Project:  stkpp::gui
 * created on: 5 oct. 2009
 * Purpose:  Define the Interface class IStep.
 * Author:   iovleff, serge.iovleff@stkpp.org
 *
 * $Log: STK_IStep.h,v $
 * Revision 1.4  2009/10/26 22:08:01  siovleff
 * Creating GProgram class
 *
 * Revision 1.3  2009/10/21 14:15:50  siovleff
 * adding accessors
 *
 * Revision 1.2  2009/10/21 13:45:23  siovleff
 * removing height and width properties
 *
 * Revision 1.1  2009/10/13 20:50:57  siovleff
 * Initial import of the model project
 *
 **/
/*--------------------------------------------------------------------*/
#ifndef STK_ISTEP_H
#define STK_ISTEP_H

#include <list>

#include "../../../projects/STKernel/include/STK_String.h"
#include "../../../projects/STKernel/include/STK_Real.h"

#include "STK_IPropertySource.h"

namespace STK
{

class Connection;

class IStep: public STK::IPropertySource
{
  private:
    static const String ID_STEP_SOURCE_CONNECTIONS;

    static const String ID_STEP_TARGET_CONNECTIONS;

    static const String ID_STEP_XLOCATION;

    static const String ID_STEP_YLOCATION;

    static const PropertyDescriptor sourceConnectionsDescriptor_;

    static const PropertyDescriptor targetConnectionsDescriptor_;

    static const PropertyDescriptor heightDescriptor_;

    static const PropertyDescriptor widthDescriptor_;

    static const PropertyDescriptor xLocationDescriptor_;

    static const PropertyDescriptor yLocationDescriptor_;

  protected:
    String name_;

    Real xLocation_;

    Real yLocation_;

    std::list<Connection*> incomingConnections_;

    std::list<Connection*> outgoingConnections_;

  public:

    IStep(String const& name, Real const& x, Real const& y);

    virtual ~IStep();

    inline String const& name() const
    { return name_;}

    inline Real const& getXLocation() const
    { return xLocation_;}

    inline Real const& getYLocation() const
    { return yLocation_;}

    inline std::list<Connection*>& getIncomingConnections()
    { return incomingConnections_;}

    inline std::list<Connection*>& getOutgoingConnections()
    { return outgoingConnections_;}

    void removeConnection(Connection* connection);

    void addConnection(Connection* connection);

    virtual bool isPropertySet(String const& id) const;

    virtual const String* getPropertyValue(String const& id) const;
};

}

#endif /* STK_ISTEP_H */