STK_Connection.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
 */

/*
 * Project:  stkpp::gui
 * created on: 2 oct. 2009
 * Purpose:  A connection between two distinct steps.
 * Author:   iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_CONNECTION_H
#define STK_CONNECTION_H

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

#include "STK_IPropertySource.h"

namespace STK
{

class IStep;

class Connection: public STK::IPropertySource
{
  public:
    enum PenStyle { // pen style
        NoPen,
        SolidLine,
        DashLine,
        DotLine,
        DashDotLine,
        DashDotDotLine,
        CustomDashLine
    };

  private:
    static const String ID_CONNECTION_LINESTYLE;

    static const String ID_CONNECTION_SOURCE;

    static const String ID_CONNECTION_TARGET;

    static const PropertyDescriptor lineStyleDescriptor_;

    static const PropertyDescriptor sourceDescriptor_;

    static const PropertyDescriptor targetDescriptor_;

    static const String lineStyleName[];

  protected:
    bool isConnected_;

    PenStyle lineStyle_;

    IStep* source_;

    IStep* target_;

  public:
    Connection( IStep* source
              , IStep* target
              , const PenStyle& lineStyle = SolidLine
              );

    virtual ~Connection();

    const PenStyle& getLineStyle() const;

    IStep* getSource() const;

    IStep* getTarget() const;

    void setLineStyle( const PenStyle& lineStyle);

    void disconnect();

    void reconnect();

    void reconnect( IStep* newSource, IStep* newTarget);

    virtual bool isPropertySet(String const& id) const;

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

}

#endif /* STK_CONNECTION_H */