torc/generic/om/NetBundle.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/NetBundle.hpp $
// $Id: NetBundle.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_NETBUNDLE_HPP
#define TORC_GENERIC_OM_NETBUNDLE_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/Net.hpp"
#include "torc/generic/om/Bundle.hpp"
#include "torc/generic/om/VisitorType.hpp"
#include "torc/generic/om/FactoryType.hpp"
#include "torc/generic/util/Error.hpp"
#include "torc/generic/om/Connectable.hpp"

namespace torc { namespace generic { class BaseVisitor; }  }

namespace torc {

namespace generic {

/**
 * @brief Represents a bundle of nets.
 *
 * The NetBundle class represents an EDIF net bundle. NetBundles are ordered collection of scalar and vector nets and can be created using the (nettBundle ...) syntax.
 */
class NetBundle :
    public Net,
    public Bundle<Net> {
#ifdef GENOM_SERIALIZATION
    friend class boost::serialization::access;
#endif //GENOM_SERIALIZATION

    friend class FactoryType<NetBundle>;

  public:
    typedef VisitorType<NetBundle> Visitor;

    /**
     * Convenience class to create a net bundle.
     */
    class Factory: public FactoryType<NetBundle>
    {
        public:
            using FactoryType<NetBundle>::create;
         /**
         * Create a net bundle.
         *
         * @param[in] inName Name of the net bundle to be created.
         * @param[in] inViewPtr Pointer to parented(View) object.
         * @param[in] inParentCollection Pointer to parent bundle.
         * @param[in] inOriginalName Original name of the net bundle [optional].
         *
         * @return Pointer to created net bundle.
         **/
            virtual NetBundleSharedPtr
            newNetBundlePtr( const std::string &inName,
                const ViewSharedPtr &inViewPtr,
                const NetBundleSharedPtr &inParentCollection = NetBundleSharedPtr(),
                const std::string &inOriginalName = std::string()) throw(Error);
    };

    virtual void
    accept(BaseVisitor & inoutVisitor) throw(Error);

    virtual void
    setParent( const ViewSharedPtr &inParent ) throw();

    /**
     * Connect the given net with this net. During connection, a none-to-one correspondence is maintained, and all children of the given net are connected to the children of the current net. As a result, if the given net is a preserved vector, it will be exploded.
     * @param[in] inNet Net to be connected to the current net
     *
     * @exception Error Provided connection is invalid, because pointer to the Net does not exist
     *       <ul>
     *         <li>
     *             Id : eMessageIdErrorPointerToItemDoesNotExist
     *         </li>
     *         <li> Context Data
     *           <ul>
     *               <li>Pointer to Net - <i>boost::shared_ptr</i></li>
     *           </ul>
     *         </li>
     *       </ul>
     *
     * @exception Error Net size does not match with NetBundle size
     *       <ul>
     *         <li>
     *             Id : eMessageIdErrorItemSizeMismatch
     *         </li>
     *         <li> Context Data
     *           <ul>
     *               <li>Net Size - <i>SizeType</i></li>
     *               <li>NetBundle Size - <i>SizeType</i></li>
     *           </ul>
     *         </li>
     *       </ul>
     *
     */
    virtual Connection
    connect(const NetSharedPtr & inNet) throw(Error);

    void
    disconnect(const Connection & inConnection) throw(Error);

    void
    disconnect() throw(Error);

    virtual
    ~NetBundle() throw();

  protected:
    NetBundle();

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

};

} // namespace torc::generic

} // namespace torc
#endif // TORC_GENERIC_OM_NETBUNDLE_HPP

---