torc/generic/om/Port.hpp

// Torc - Copyright 2011 University of Southern California.  All Rights Reserved.
// $HeadURL: https://torc-isi.svn.sourceforge.net/svnroot/torc-isi/branches/staging/0.9/src/torc/generic/om/Port.hpp $
// $Id: Port.hpp 10 2011-10-12 18:40:16Z nsteiner $

// 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 3 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, see <http://www.gnu.org/licenses/>.

#ifndef TORC_GENERIC_OM_PORT_HPP
#define TORC_GENERIC_OM_PORT_HPP

#include "torc/generic/om/PointerTypes.hpp"
#include "torc/generic/om/DumpRestoreConfig.hpp"

//BOOST
#ifdef GENOM_SERIALIZATION
#include <boost/serialization/access.hpp>
#endif //GENOM_SERIALIZATION

#include "torc/generic/om/Commentable.hpp"
#include "torc/generic/om/Connectable.hpp"
#include "torc/generic/om/Extern.hpp"
#include "torc/generic/om/Nameable.hpp"
#include "torc/generic/om/PropertyContainer.hpp"
#include "torc/generic/om/Renamable.hpp"
#include "torc/generic/om/Visitable.hpp"
#include "torc/generic/om/Composite.hpp"
#include "torc/generic/om/ParentedObject.hpp"
#include "torc/generic/om/PortDirection.hpp"
#include "torc/generic/om/View.hpp"
#include "torc/generic/om/UserDataContainer.hpp"

namespace torc { namespace generic { class PortAttributes; }  } 

namespace torc {

namespace generic {

/**
 * @brief Interface for an EDIF port object
 * 
 * The Port class acts as an interface for ports in an EDIF cell. A port can be of scalar, vector or bundle type. This class provides a simplified view of all three types of port. To get a handle to an actual port, the client will have to use a Visitor with proper overloads of the visit() function, or dynamic_cast can be used. The latter method is however not recommended. A port object supports storing properties for storing different EDIF properties. See documentation of the Property and PropertyContainer classes for more details.
 */
class Port :
    public Commentable,
    public Connectable,
    public Extern,
    public Nameable,
    public PropertyContainer,
    public Renamable,
    public Visitable,
    virtual public Composite<Port>,
    public ParentedObject<View>,
    public UserDataContainer
{
#ifdef GENOM_SERIALIZATION
    friend class boost::serialization::access;
#endif //GENOM_SERIALIZATION

  public:
    /**
     * Get the direction of port
     * 
     * @return Direction of port
     */
    inline const PortDirection
    getDirection() const throw();

    /**
     * Set the direction of port
     * 
     * @param[in] inSource Direction of port
     */
    void
    setDirection(const PortDirection & inSource) throw();

    /**
     * Get the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.
     * 
     * @return Pointer to PortAttributes object.
     */
    inline const PortAttributesSharedPtr
    getAttributes() const throw();

    /**
     * Set the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.
     * 
     * @note This method does not check whether prior set of properties exist or not. Newly set property will remove old properties.
     * 
     * @param[in] inSource Pointer to PortAttributes object.
     */
    void
    setAttributes(const PortAttributesSharedPtr & inSource) throw();

  protected:
    explicit Port();

  public:
    virtual ~Port() throw();

  private:
#ifdef GENOM_SERIALIZATION
    template<class Archive> void
    serialize( Archive &ar, unsigned int );
#endif //GENOM_SERIALIZATION

    Port(const Port & source) throw();

    Port &
    operator=(const Port & source) throw();


    PortDirection mDirection;
    PortAttributesSharedPtr mAttributes;
};

/**
 * Get the direction of port
 * 
 * @return Direction of port
 */
inline const PortDirection
Port::getDirection() const throw() {
  return mDirection;
}

/**
 * Get the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.
 * 
 * @return Pointer to PortAttributes object.
 */
inline const PortAttributesSharedPtr
Port::getAttributes() const throw() {
  return mAttributes;
}

} // namespace torc::generic

} // namespace torc
#endif // TORC_GENERIC_OM_PORT_HPP

---