torc/generic/om/SingleInstance.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/SingleInstance.hpp $
// $Id: SingleInstance.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_SINGLEINSTANCE_HPP
#define TORC_GENERIC_OM_SINGLEINSTANCE_HPP

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

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

#include "torc/generic/om/Instance.hpp"
#include "torc/generic/om/Scalar.hpp"
#include "torc/generic/om/FactoryType.hpp"
#include "torc/generic/om/VisitorType.hpp"
#include "torc/generic/util/Error.hpp"

namespace torc { namespace generic { class BaseVisitor; }  }

namespace torc {

namespace generic {

/**
 * @brief Represents a single instance of the view of a cell.
 *
 * The SingleInstance class represents a usage instance of a cell in the design specification (View) of another cell. A single instance can be created using the (instance name ...) syntax.
 */
class SingleInstance
    : public Instance,
    public Scalar<Instance> {
#ifdef GENOM_SERIALIZATION
    friend class boost::serialization::access;
#endif //GENOM_SERIALIZATION

    friend class FactoryType<SingleInstance>;

  public:
    typedef VisitorType<SingleInstance> Visitor;

    /**
     * Convenience class to create a single instance.
     */
    class Factory: public FactoryType<SingleInstance>
    {
        public:
            using FactoryType<SingleInstance>::create;
        /**
         * Create a single instance.
         * @param[in] inName Name of the single instance to be created.              
         * @param[in] inViewPtr Pointer to parented(View) object.              
         * @param[in] inMasterPtr Pointer to master(View) object.
         * @param[in] inOriginalName Original name of the single instance [optional].              
         *              
         * @return Pointer to created single instance.             
         */               
            virtual SingleInstanceSharedPtr
            newSingleInstancePtr( const std::string &inName,
                const ViewSharedPtr &inViewPtr,
                const ViewSharedPtr &inMasterPtr,
                const std::string &inOriginalName = std::string()) throw(Error);
    };

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

    /**
     * Flatten an instance so that internal references
     */
    virtual void
    flatten() throw(Error);

    virtual
    ~SingleInstance() throw();

  protected:
    SingleInstance();

  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_SINGLEINSTANCE_HPP

---